References
Users Resources
Resources and actions to manage the users of an organization
Get authentication organization and user information
Returns the user and organization information for the API key used for authentication.
No parameters
200: OK
User and Organization Resource Objects
User and Organization Resource Objects
{
"user": {
"avatar": "...",
"email": "...",
"id": "...",
"name": "...",
"timezone": "...",
...
},
"organization": {
"id": "...",
"name": "...",
"subdomain": "..",
"url_home": "..",
"created_at": 1590851285
}
}
List team members
Returns a list of team members in the organization.
Filter by user ID, leave empty to return all
Filter by user email, leave empty to return all.
Filter by team role, leave empty to return all. Available roles: coach
, admin
Available sort fields: created_at
, name
, role
200: OK
List of Team Member Resource objects
List of Team Member Resource objects
{
"data": [
{
"id": "...",
"avatar": "...",
"name": "...",
"email": "...",
"timezone": "...",
"role": "admin",
"created_at": null
},
...
]
}
List clients
Returns a list of clients in the organization
User ID
User email address
Available sort fields: created_at
, name
200: OK
A paginated list of Client Resource Objects
A paginated list of Client Resource Objects
{
"data": [
{
"id": "...",
"avatar": "...",
"name": "...",
"email": "...",
"timezone": "...",
"created_at": 1637585633,
"info": {
"...": "...",
...
}
},
...
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": ...,
"from": ...,
"last_page": ...,
"path": "...",
"per_page": ...,
"to": ...,
"total": ...
}
}
Add new client
Adds a new client to the organization
Full name
Email address
Password (min. 8 characters)
Timezone (any value from tz database)
boolean
(send invitation email to clients)
200: OK
Client Resource Object
Client Resource Object
{
"client": {
"id": "...",
"avatar": "...",
"name": "...",
"email": "...",
"timezone": "...",
"created_at": ...,
"info": {
"...": "...",
...
}
}
}
Update a client
Updates a client's custom field information.
String
: User ID
Object
: A key-value object that has field slugs as its keys and values for the new information to be saved
200: OK
Client Resource Object
Client Resource Object
{
"client": {
"id": "...",
"avatar": "...",
"name": "...",
"email": "...",
"timezone": "...",
"created_at": ...,
"info": {
"...": "...",
...
}
}
}
Update user's profile information
Updates the authenticated user's profile information.
string
string
string, https://en.wikipedia.org/wiki/List_of_tz_database_time_zones TZ identifier
string, one of never
, weekly
, hourly
, daily
boolean
200: OK
User and Organization Resource Objects
User and Organization Resource Objects
{
"user": {
"avatar": "...",
"email": "...",
"id": "...",
"name": "...",
"timezone": "...",
...
},
"organization": {
"id": "...",
"name": "...",
"subdomain": "..",
"url_home": "..",
"created_at": 1590851285
}
}
Update user's profile avatar image
Updates the authenticated user's profile avatar image.
image file (jpg, png, gif), max 4mb
200: OK
User and Organization Resource Objects
User and Organization Resource Objects
{
"user": {
"avatar": "...",
"email": "...",
"id": "...",
"name": "...",
"timezone": "...",
...
},
"organization": {
"id": "...",
"name": "...",
"subdomain": "..",
"url_home": "..",
"created_at": 1590851285
}
}
Resource Objects
User
Property | Type | Description |
---|---|---|
id | string | User ID |
name | string | User's full name |
string | User's email address | |
avatar | string | User avatar URL |
timezone | string | User's timezone |
email_notifications | string | Email notification preference for the user. One of |
digests | boolean | Whether user receives digests or not |
Team Member, Client and Program Member resource objects inherit properties from this User resource object.
Organization
Property | Type | Description |
---|---|---|
id | string | Organization ID |
name | string | Organization name |
subdomain | string | Organization subdomain |
url_home | string | Organization home URL |
created_at | integer | Organization created at (Unix timestamp) |
Team Member
Inherits all the properties of the User Resource and extends it with the following properties
Property | Type | Description |
---|---|---|
role | string | Team role, can be |
created_at | integer | Team member created at (Unix timestamp) |
Client
Inherits all the properties of the User Resource and extends it with the following properties
Property | Type | Description |
---|---|---|
created_at | integer | Client created at (Unix timestamp) |
info | object or null | A key-value object listing all the client custom fields. If there are no custom fields, it will be a null value |