Skip to main content

Users

This object represents an end-user within an event organization. Users can be attendees, vendors, performers, staff, etc.

Get user​

Search for users using a variety of filters. A maximum of 100 results will be returned per request. If additional results are available, they can be retrieved using the nextPage parameter from the previous response.

Authentication

Service Integration with user:read scope.

Response

link
idstring

The unique identifier of the user.

link
emailstring

The email address of the user.

link
preferredNamestring (optional)
nullable

The preferred name of the user. If provided, this should be used instead of the first and ast name, except where legally required.

link
firstNamestring

The first name of the user.

link
lastNamestring

The last name of the user.

link
usernamestring

The username of the user.

link
verifiedboolean

Whether the user has verified their email address.

link
phoneboolean

The phone number of the user in E.164 format.

link
addressAddress (optional)
nullable
The address of the user. If PII is not required to register, the child attributes will be null.
Show child attributes
link
addressCitystring

The city of the address.

link
addressCountrystring

The two-letter country code of the address.

link
addressLine1string

The first line of the address.

link
addressLine2string (optional)
nullable

The second line of the address, such as an apartment number, if applicable.

link
addressStatestring

The state or province of the address.

link
addressZipcodestring

The ZIP or postal code of the address.

GET /api/v0/users/:idJSON
{
"id": "1234",
"email": "johnny.test@concat.systems",
"preferredName": "JT",
"firstName": "John",
"lastName": "Test",
"username": "jtest",
"verified": true,
"phone": "+15555555555",
"address": {
  "addressCity": "San Francisco",
  "addressCountry": "US",
  "addressLine1": "123 Main St",
  "addressLine2": "Apt 1",
  "addressState": "CA",
  "addressZipcode": "94105"
}
}

Search users​

Search for users using a variety of filters. A maximum of 100 results will be returned per request. If additional results are available, they can be retrieved using the nextPage parameter from the previous response.

Authentication

Service Integration with user:read scope.

Request

link
nextPagestring (optional)

A cursor for pagination across multiple pages of results. Don't include this attribute on the first call. Use the nextPage parameter from the previous response for each subsequent request.

link
limitnumber (optional)

The maximum number of results to return, between 1 and 100. Defaults to 100.

link
filterobject (optional)
Filters to apply to the search.
Show child attributes
link
roleIdnumber (optional)

The ID of the role to filter by.

Response

link
dataArray of User (optional)
nullable
The users that match the search.
Show child attributes
link
idstring

The unique identifier of the user.

link
emailstring

The email address of the user.

link
preferredNamestring (optional)
nullable

The preferred name of the user. If provided, this should be used instead of the first and ast name, except where legally required.

link
firstNamestring

The first name of the user.

link
lastNamestring

The last name of the user.

link
usernamestring

The username of the user.

link
verifiedboolean

Whether the user has verified their email address.

link
phoneboolean

The phone number of the user in E.164 format.

link
addressAddress (optional)
nullable
The address of the user. If PII is not required to register, the child attributes will be null.
Show child attributes
link
addressCitystring

The city of the address.

link
addressCountrystring

The two-letter country code of the address.

link
addressLine1string

The first line of the address.

link
addressLine2string (optional)
nullable

The second line of the address, such as an apartment number, if applicable.

link
addressStatestring

The state or province of the address.

link
addressZipcodestring

The ZIP or postal code of the address.

link
nextPagestring (optional)
nullable

A cursor for pagination across multiple pages of results. If this attribute is present, there are more results available. Use this value in the nextPage parameter for the next request.

POST /api/v0/users/searchJSON
{
"nextPage": "eyBsYXN0SWQ6IDEwMDAgfQ==",
"limit": 100,
"filter": {
  "roleId": 12,
},
}
Responseapplication/json
{
"data": [
  {
    "id": "1234",
    "email": "johnny.test@concat.systems",
    "preferredName": "JT",
    "firstName": "John",
    "lastName": "Test",
    "username": "jtest",
    "verified": true,
    "phone": "+15555555555",
    "address": {
      "addressCity": "San Francisco",
      "addressCountry": "US",
      "addressLine1": "123 Main St",
      "addressLine2": "Apt 1",
      "addressState": "CA",
      "addressZipcode": "94105"
    },
  },
],
"nextPage": null
}