Resources
A resource is an agent or a team who can have an appointment scheduled for them.
This is a convenience endpoint, designed for easily retrieving a list of all resources available for scheduling, so that this can be displayed in a UI for selection. To make changes to agents or teams, use the agents or teams resources.
GET/v1/resources
Retrieve all resources
This endpoint returns a list of all resources.
The response will be a paginated list object. The data field will be heterogenous array of resources, which
means that it can include items of both team and agent types.
Supported TQL Attributes
The resources endpoint can be filtered using the following TQL attributes:
| Attribute | Type | Supported Operators |
|---|---|---|
resource.internal_name — This will match either the name of an agent, or the internal_name of a team. | String | EQ, NOT_EQ, LIKE, NOT_LIKE, IN, NOT_IN |
resource.external_name — This will match either the name of an agent, or the external_name of a team. | String | EQ, NOT_EQ, LIKE, NOT_LIKE, IN, NOT_IN |
resource.url_slug | String | EQ, NOT_EQ, LIKE, NOT_LIKE, IN, NOT_IN |
Request
curl https://api.timezest.com/v1/resources \
-H "Authorization: Bearer <Your API Token>"
Response
{
"object": "list",
"next_page": "https://api.timezest.com/v1/resources?starting_after=team_W4hPN4gKvru7c4BWerF4d",
"previous_page": null,
"data": [
{
"id": "agnt_2wvARLFjTDmO4djuOBf3r",
"object": "agent",
"name": "Teresa Smith",
"email": "[email protected]",
"role": "administrator",
"schedulable": true,
"two_factor_enabled": false,
"url_slug": "teresa-smith",
"created_at": 1692172402,
"updated_at": 1692172694
},
{
"id": "team_W4hPN4gKvru7c4BWerF4d",
"object": "team",
"internal_name": "Implementation Team",
"external_name": null,
"team_type": "connectwise/project",
"url_slug": "implementation",
"created_at": 1692165109,
"updated_at": 1692165109
},
]
}