References
Programs and Members Resources
Resources and actions to manage programs and their members
List programs
Returns a list of programs in the organization
Program ID
Available sort fields: name
, created_at
Number of paginated items
200: OK
A paginated list of Program Resource Objects
A paginated list of Program Resource Objects
{
"data": [
{
"id": "...",
"name": "...",
"created_at": ...
},
...
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": ...,
"from": ...,
"last_page": ...,
"path": "...",
"per_page": ...,
"to": ...,
"total": ...
}
}
List program members
Returns a list of members of the program
Program ID
User ID
User email address
Member role
Member timezone
Available sort fields: name
, created_at
200: OK
A paginated list of Program Member Resource Objects
A paginated list of Program Member Resource Objects
{
"data": [
{
"id": "...",
"avatar": "...",
"name": "...",
"email": "...",
"timezone": "...",
"role": "...",
"created_at": ...,
"info": {
"...": "...",
...
}
},
...
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": ...,
"from": ...,
"last_page": ...,
"path": "...",
"per_page": ...,
"to": ...,
"total": ...
}
}
Add member to a program
Adds a new member to a program
*
Program ID
ID of the user to be added to the program as a member
200: OK
Program Member Resource Object
Program Member Resource Object
{
"program_member": {
"id": "...",
"avatar": "...",
"name": "...",
"email": "...",
"timezone": "...",
"role": "...",
"created_at": ...
}
}
List program member timezones
Returns a list of timezones of program members
No parameters
200: OK
A plain list of all the distinct timezones available in the program
A plain list of all the distinct timezones available in the program
{
"timezones": [
"Europe/Istanbul",
"Europe/London",
...
]
}
Resource Objects
Program
Property | Type | Description |
---|---|---|
id | string | Program ID |
name | string | Program name |
created_at | integer | Program created date and time (Unix timestamp) |
Program Member
Inherits all the properties of the User Resource and extends it with the following properties
Property | Type | Description |
---|---|---|
role | string | Member role, can be |
created_at | integer | Program member 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 |