v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Users

Get user

Get a user by ID.

get/users/{id}

Path parameters

idstring required

Example:611d02b7c9c54b01736ae01d

The unique identifier of the user.

Query parameters

fieldsstring

Selection of fields, separated by space

Response

Success response

_idstring

User MongoDB _id

accountIdstring

Your account ID

emailstring

emailsstring[]

firstNamestring

userStartedUpdateEmailFlowboolean

lastNamestring

fullNamestring

titlestring

timezonestring

tagsstring[]

lastActivityTimenumber

phonestring

phonesstring[]

preferredContactMethodstring

noteBeforeContactingstring

notesstring

displayLanguagestring

Example response

{
  "_id": "611d02b7c9c54b01736ae01d",
  "accountId": "611cf837c9c54b01736ae01c",
  "email": "example@email.com",
  "emails": [
    "example@email.com"
  ],
  "firstName": "John",
  "lastName": "Boe",
  "fullName": "John Boe",
  "title": "CTO",
  "timezone": "Europe/Zurich",
  "picture": {
    "thumbnail": "https://thumbnail.url.com",
    "regular": "https://regular.url.com",
    "large": "https://large.url.com"
  },
  "tags": [
    "tag1"
  ],
  "settings": {
    "notifications": {
      "subscriptions": [
        {
          "type": "PAYMENT",
          "name": "FAILED",
          "targets": [
            "DASHBOARD"
          ]
        }
      ]
    }
  }
}