Users API

Available Endpoints

Endpoints

GET/api/v1/users

GET/api/v1/users/{key}

PUT/api/v1/users/{key}

DELETE/api/v1/users/{key}

The User Object

key string

Unique identifier for the user

created_at string

Created at in specified timezone

created_at_string string

Created at formatted as human-readable string

created_at_utc string

Created at in UTC

email string

User's email address

groups array

Permission groups the user belongs to

id string

System-generated unique identifier

name string

User's display name

object string

Object type identifier

time_zone string

Time zone setting for the user in IANA timezone format (e.g. 'America/New_York', 'Europe/London', 'Asia/Tokyo', 'Etc/UTC')

user_data_schema array

User's data schema configuration

User Object

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
  "key": "user-2",
  "created_at": "2025-08-19T11:19:17-04:00",
  "created_at_string": "Aug 19, 2025 11:19 am EDT",
  "created_at_utc": "2025-08-19T15:19:17Z",
  "email": "person3@example.com",
  "groups": null,
  "id": "0198c2e9-c560-71f3-8bfe-6afe43427495",
  "name": null,
  "object": "user",
  "time_zone": "America/New_York",
  "user_data_schema": [
    {
      "variable": "first_name",
      "data_path": "first_name",
      "display_label": "First Name",
      "format": null,
      "groups": null,
      "list_values_variable": null,
      "object": "data_type",
      "required": false,
      "source": "user",
      "type": "String",
      "value": null
    },
    {
      "variable": "last_name",
      "data_path": "last_name",
      "display_label": "Last Name",
      "format": null,
      "groups": null,
      "list_values_variable": null,
      "object": "data_type",
      "required": false,
      "source": "user",
      "type": "String",
      "value": null
    }
  ]
}