Docs

Get Users

GET /Events/{eventId}/users

GET/Events/{eventId}/users

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.

Returns all users who have been granted access to the event, along with their profile information, license feature flags, and the collaborator they are associated with.

Path Parameters

FieldTypeRequiredDescription
eventIdGuidRequiredThe ID of the event.

Example Response

[
  {
    "id": "d1e2f3a4-b5c6-7890-d1e2-f3a4b5c67890",
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "jane@productionco.com",
    "licenseFeatureFlags": ["pro", "advancedReporting"],
    "collaborator": {
      "id": "0197f069-bd91-76c8-bfd0-5e287b932da7",
      "name": "Production Co."
    }
  },
  {
    "id": "aabbccdd-eeff-1122-3344-556677889900",
    "firstName": "Bob",
    "lastName": "Jones",
    "email": "bob@cateringinc.com",
    "licenseFeatureFlags": [],
    "collaborator": {
      "id": "0197f069-bd91-76c8-bfd0-5e287b932da8",
      "name": "Catering Inc."
    }
  }
]

Response Fields

FieldTypeDescription
idGuidThe user's ID.
firstNamestringUser's first name.
lastNamestringUser's last name.
emailstringUser's email address.
licenseFeatureFlagsstring[]Feature flags active for this user's license on this event.
collaborator.idGuidThe collaborator the user is a crew member of.
collaborator.namestringThe collaborator's display name.

Error Codes

CodeHTTP StatusDescription
UNAUTHORIZED401Missing or invalid token.
NOT_FOUND404Event not found.