Event Passes

List event passes

List passes for an event.

Jump to examples ↓

GET /events/project/{projectId}/{eventId}/passes

Security:

Query parameters:

• status string

  Find only passes matching the installation status.

  • installed — passes currently installed.
  • uninstalled — passes that have been uninstalled.
  • been_installed — passes that have been either installed or uninstalled.
  • not_been_installed — passes that have never been installed.

  Possible values: installed, uninstalled, been_installed, not_been_installed

• pageSize integer
  The number of passes per page. Defaults to 10.

  Default: 10

• page integer
  The page of results you want to retrieve, starting at 1.

  Default: 1

• order string
  The order you want passes returned in, defaulting to id.

  Possible values: id, createdAt, updatedAt

  Default: id

• direction string
  Determines whether to return values in ascending or descending order. Defaults to DESC.

  Possible values: ASC, DESC

  Default: DESC

Request headers:

• Api-Revision stringREQUIRED
  The particular API revision you want to use. In general, this is 1.2.

  Possible values: 1.2

Path parameters:

• projectId integerREQUIRED
  The project that the event belongs to.
• eventId integerREQUIRED
  The event you want to get passes for.

Responses

• 200

  A successful request returns a paged list of passes for a particular event.

  Response body:

  • Content-Type: application/json
    OBJECT PROPERTIES
    • count integer

      The total number of passes associated with a event

    • pagination object<Pagination object>

      Contains information about pagination, according to your query parameters.

    • passes array[object]

      The metadata for passes associated with the event. Each object in the array represents a pass.

• 404

  The event ID does not exist.

Examples

GET /v1/events/project/12345/1234/passes HTTP/1.1
Authorization: Basic <authorization string>

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
          "passes": [{
              "id": 616,
              "templateId": 1000057,
              "url": "https://d720-104-177-34-165.ngrok.io/v1/pass/616/download",
              "serialNumber": "aff7ffbf-04d7-4180-9da2-c790e08da0b8",
              "createdAt": "2023-04-19T06:17:01.000Z",
              "updatedAt": "2023-04-19T06:17:01.000Z",
              "status": "installed",
              "installedAt": "2023-04-19T06:17:02.000Z",
              "platform": "android"
            },
            {
              "id": 610,
              "templateId": 1000083,
              "url": "https://d720-104-177-34-165.ngrok.io/v1/pass/610/download",
              "serialNumber": "34b6f9de-3745-4107-99ae-3f952208e216",
              "createdAt": "2023-04-05T17:55:23.000Z",
              "updatedAt": "2023-04-05T17:55:23.000Z",
              "status": "installed",
              "installedAt": "2023-04-05T17:55:23.000Z",
              "platform": "android"
            }
          ],
          "pagination": {
            "order": "id",
            "direction": "desc",
            "page": 1,
            "start": 0,
            "pageSize": 2
          }
}