/api/v1/ticketing-teams/{ticketingTeamId}/users (GET)

GET

/api/v1/ticketing-teams/{ticketingTeamId}/users

curl --request GET \
  --url 'https://api.endless.zaia.app/api/v1/ticketing-teams/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/users?pageNumber=1&pageSize=10'

• API Server

Retrieves multiple users in a ticketing team.

Parameters

Path Parameters

ticketingTeamId

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Query Parameters

joins

Any of:

Array<string>

Array<string>

Allowed values: users workspace-users

string

string

Allowed values: users workspace-users

pageNumber

The page number.

number

default: 1 >= 1

The page number.

pageSize

The page size.

number

default: 10 >= 1 <= 100

The page size.

Responses

200

Retrieves all ticketing team users.

Media typeapplication/json

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

activeTickets

required

integer

roundRobinDistribution

required

integer

<= 100

status

required

string

Allowed values: active inactive

ticketingTeamId

required

A UUID v4 string that identifies an entity.

string format: uuid

userId

required

A UUID v4 string that identifies an entity.

string format: uuid

user

object

createdAt

required

string format: date-time

id

required

A UUID v4 string that identifies an entity.

string format: uuid

updatedAt

required

string format: date-time

authVersion

required

The authentication version used to invalidate access tokens.

integer

brandId

required

The brand ID associated with the user.

string format: uuid

nullable

canonicalUserId

required

The canonical user ID when this row was merged into another user.

string format: uuid

nullable

clientReferenceId

required

The external client reference ID associated with the user.

string

nullable

email

required

The email address of the user.

string format: email

emailNormalized

required

The normalized email used for global uniqueness.

string

>= 1 characters

emailStatus

required

The email verification status of the user.

string

Allowed values: pending verified

firstAccessAt

required

When the user first accessed the platform.

string format: date-time

nullable

gtm

required

The GTM parameters to be used in tracking events for the user.

object

key

additional properties

string

language

required

The preferred language configured for the user.

string

Allowed values: enUs esEs ptBr

lastAuthenticationAt

required

When the user last authenticated.

string format: date-time

nullable

metadata

required

Metadata to be used in tracking events for the user.

object

key

additional properties

string

name

required

The display name of the user.

string

nullable >= 3 characters <= 50 characters

phoneNumber

required

string

nullable >= 6 characters <= 15 characters

picture

required

The picture associated with the user.

string

nullable

superIdentityId

required

The super identity ID associated with the user.

string format: uuid

whiteLabelId

required

The white label ID associated with the user, when one exists.

string format: uuid

nullable

workspaceUser

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

inviteStatus

required

string

Allowed values: pending accepted rejected

isRemoved

required

boolean

role

required

string

Allowed values: member admin owner ops

ticketingAvailability

required

string

Allowed values: available unavailable

userId

required

A UUID v4 string that identifies an entity.

string format: uuid

workspaceId

required

A UUID v4 string that identifies an entity.

string format: uuid

Example

[
  {
    "status": "active",
    "user": {
      "emailStatus": "pending",
      "language": "enUs"
    },
    "workspaceUser": {
      "inviteStatus": "pending",
      "role": "member",
      "ticketingAvailability": "available"
    }
  }
]

401

Unauthorized.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

404

Ticketing team not found.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}