Skip to main content

Users

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

Retrieve Current User​

Returns the user object for the currently authenticated user.

Authentication

On Behalf Of (OBO) with pii:basic scope. Other permissions are required to access additional information, such as PII and order history.

Response

link
bornAtstring
The date the user was born, in ISO 8601 format.
link
emailMd5string
The MD5 hash of the user's email address.
link
firstNamestring
The user's legal first name, as it appears on their ID.
link
idnumber
The ID of the user.
link
lastNamestring
The user's legal last name, as it appears on their ID.
link
permissionsarray of string
The permissions granted to the user.
link
preferredNamestring (optional)
nullable
An optional preferred name for the user. This will be displayed first on the user's profile.
link
newsletterboolean
Whether the user has opted in to the newsletter.
link
identityVerifiedboolean
Returns true if the user has verified their identity.
link
isVolunteerboolean
Returns true if the user is an assigned volunteer.
link
usernamestring
The user's username.
Scope Restricted Attributes
link
lockaddressCitystring
City, town, or village of the user's address.
Required Scope(s): pii:address
link
lockaddressCountrystring
Two-letter ISO 3166-1 alpha-2 country code.
Required Scope(s): pii:address
link
lockaddressLine1string
First line of the user's address. (e.g. 1234 Main St)
Required Scope(s): pii:address
link
lockaddressLine2string (optional)
nullable
Optional second line of the user's address. (e.g. Suite 100, Apt 2B)
Required Scope(s): pii:address
link
lockaddressStatestring
State or province of the user's address.
Required Scope(s): pii:address
link
lockaddressZipcodestring
ZIP or postal code of the user's address.
Required Scope(s): pii:address
link
lockemailstring
The user's email address.
Required Scope(s): pii:email
link
lockphonestring
Phone number in international format. (e.g. +15555555555)
Required Scope(s): pii:phone
GET /api/users/:idcURL
curl https://reg.cces.dev/api/users/current \
  -H "Authorization: Bearer <token>"
Responseapplication/json
{
  "addressCity": "New York",
  "addressCountry": "US",
  "addressLine1": "123 Main St",
  "addressLine2": "Suite 100",
  "addressState": "NY",
  "addressZipcode": "10001",
  "bornAt": "1990-01-01T00:00:00.000Z",
  "email": "[email protected]",
  "firstName": "John",
  "id": 1234,
  "lastName": "Doe",
  "newsletter": true,
  "phone": "+15555555555",
  "preferredName": "Jonathan",
  "username": "aperson",
  "identityVerified": true,
  "isVolunteer": true,
  "permissions": [],
}