Skip to main content
GET
/
event-medias
Retrieve defined event media
curl --request GET \
  --url https://api.nuwebgroup.com/v1/event-medias \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "eventMedia",
      "id": 1,
      "attributes": {
        "name": "Standard Venue Ticket",
        "isVisibleInBoxOffice": true,
        "globalDefaults": {
          "fallback": true,
          "ticket": false,
          "product": false,
          "seasonTicket": true
        }
      }
    }
  ],
  "links": {
    "first": "http://api.willms.com/v1/event-medias?page=1",
    "last": "http://api.willms.com/v1/event-medias?page=5",
    "prev": "http://api.willms.com/v1/event-medias?page=2",
    "next": "http://api.willms.com/v1/event-medias?page=5",
    "self": "http://api.willms.com/v1/event-medias?page=3"
  },
  "meta": {
    "total": 4
  }
}

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Headers

ā€‹
X-NU-COMPANY-ID
integer

The ID of the company this operation should be performed against.

Query Parameters

ā€‹
offset
integer

The starting position in the result set. e.g. 100 for the 100th record onwards. Offset will always take precedence over page.

ā€‹
page
integer

The page you wish to retrieve records for, using the default pagination page length. You can only paginate by page if no offset is given.

ā€‹
limit
integer

The number of records you wish to retrieve per page.

ā€‹
only
string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. resource.attribute,includedResource.attribute. Can be used in conjunction with except providing both parameters don't reference the same resource.

ā€‹
except
string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. resource.attribute,includedResource.attribute. Can be used in conjunction with only providing both parameters don't reference the same resource.

ā€‹
withTrashed
enum<string>
default:false

Controls records returned depending on their deletedAt status. This is a global flag, so will apply to all resources, including relationships such as resources returned under the included attribute.

  • true to include deleted records
  • false to exclude deleted records (or leave blank)

Available options:
true,
false

Response

Successfully retrieved the event media list.

ā€‹
data
object[]
ā€‹
links
object

These URLs can be used to navigate paginated requests.

ā€‹
meta
object