Skip to main content

Registrations

This object represents event registrations within a convention.

Get Registration​

Gets a single user registration by the giver user id.

Authentication

Service Integration with registration:read scope.

Request

link
createdAtstring
The date the registration record was created.
link
updatedAtstring
The date the registration record was last updated.
link
badgeNamestring
User input field about the badge name.
link
statusstring
Current status of the registration. Either "paid" or "unpaid".
link
productNamestring
The name of the product the user purchashed when "paid", or intent to purchase when "unpaid".
link
productDisplayNamestring
The display name of the product.
link
productIdstring
The unique identifier for the product.
link
optionsArray of Option
A set of options, customized by the event, that contain arbitrary data provided by the volunteer.
Show child attributes
link
namestring
The name of the option as defined by the event.
link
typestring
The type of the option as defined by the event.
Possible values: select, multi, text, number.
link
valuenumber, string, or Array of string
The value of the option.
link
flagsArray of flag
Flag information
Show child attributes
link
idstring
The unique identifier of the flag.
link
shortNamestring
The flag short name.
link
userUser
User information
Show child attributes
link
idstring
The unique identifier of the user.
link
firstNamestring
The first name of the user.
link
lastNamestring
The last name of the user.
link
usernamestring
The username of the user.
link
preferredNamestring (optional)
nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
link
phonestring
The phone number of the user in E.164 format.
link
emailstring
The email address of the user.
GET /api/v0/users/{id}/registrationJSON
ResponseJSON
{
  "createdAt": "2022-02-23T00:30:47.468Z",
  "updatedAt": "2022-09-21T01:04:51.456Z",
  "badgeName": "Joe",
  "status": "paid",
  "productName": "Patron",
  "productDisplayName": null,
  "productId": "172",
  "options": [
      {
          "name": "Species",
          "type": "text",
          "value": "Mega Bunny"
      },
      {
          "name": "Shirt Size",
          "type": "select",
          "value": "M"
      }
  ],
  "flags": [
      {
          "id": "1",
          "shortName": "fursuits"
      }
  ],
  "user": {
      "id": "1234",
      "firstName": "John",
      "lastName": "Doe",
      "username": "jdoe",
      "preferredName": "Johnny",
      "phone": "+15555555555",
      "email": "[email protected]"
  }
}

Search registrations​

Search for registrations. 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 registration: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
userIdsnumber (optional)
The ID of the user to filter by.

Response

link
dataArray of User (optional)
nullable
The registrations that match the search.
Show child attributes
link
createdAtstring
The date the registration record was created.
link
updatedAtstring
The date the registration record was last updated.
link
badgeNamestring
User input field about the badge name.
link
statusstring
Current status of the registration. Either "paid" or "unpaid".
link
productNamestring
The name of the product the user purchashed when "paid", or intent to purchase when "unpaid".
link
productDisplayNamestring
The display name of the product.
link
productIdstring
The unique identifier for the product.
link
optionsArray of Option
A set of options, customized by the event, that contain arbitrary data provided by the volunteer.
Show child attributes
link
namestring
The name of the option as defined by the event.
link
typestring
The type of the option as defined by the event.
Possible values: select, multi, text, number.
link
valuenumber, string, or Array of string
The value of the option.
link
flagsArray of flag
Flag information
Show child attributes
link
idstring
The unique identifier of the flag.
link
shortNamestring
The flag short name.
link
userUser
User information
Show child attributes
link
idstring
The unique identifier of the user.
link
firstNamestring
The first name of the user.
link
lastNamestring
The last name of the user.
link
usernamestring
The username of the user.
link
preferredNamestring (optional)
nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
link
phonestring
The phone number of the user in E.164 format.
link
emailstring
The email address of the user.
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/registration/searchJSON
{
  "nextPage": "eyBsYXN0SWQ6IDEwMDAgfQ==",
  "limit": 100,
  "filter": {
    "userIds": ["1", "2", "3"],
  },
}
ResponseJSON
{
  "data": [
    {
      "createdAt": "2022-02-23T00:30:47.468Z",
      "updatedAt": "2022-09-21T01:04:51.456Z",
      "badgeName": "Joe",
      "status": "paid",
      "productName": "Patron",
      "productDisplayName": null,
      "productId": "172",
      "options": [
          {
              "name": "Species",
              "type": "text",
              "value": "Mega Bunny"
          },
          {
              "name": "Shirt Size",
              "type": "select",
              "value": "M"
          }
      ],
      "flags": [
          {
              "id": "1",
              "shortName": "fursuits"
          }
      ],
      "user": {
          "id": "1234",
          "firstName": "John",
          "lastName": "Doe",
          "username": "jdoe",
          "preferredName": "Johnny",
          "phone": "+15555555555",
          "email": "[email protected]"
      }
    },
  ],
  "nextPage": null
}