get https://api.talkdeskapp.com/industries-scheduler/teams
Get teams associated with an account by team ID.
Scope
industries-scheduler-teams:read
Body Response - Schema
200 OK
| Parameter | Type | Description |
|---|---|---|
| _embedded | object | "_embedded" subdivides into: 1 - "teams" (array[object]) - "teams" subdivides into: 1.1 - "id" (string) - The unique ID that ideitifies the team. Required. 1.2 - "topic"(object) - The team's details. "topic" subdivides into: 1.2.1 - "name"(string) - The topic's name. Required. 1.2.2 - "meetings duration"(object) -The meeting's duration in minutes. Required. 1.2.3 - members" (array[object]) - List of members. In subTopics are only allowed members presented in the main topic. "members" subdivides into: 1.2.3.1. - "name"(string) - Topic name. 1.2.3.2 - "email"(string) - Team member's email. Required. 1.2.3.3 - "provider"(string) - Team member email provider. Required. Allowed values: GOOGLE, OUTLOOK 1.2.3.4 - "status"(string) - Team member status - ACTIVE after the member has given access to his calendar, otherwise is PENDING. Allowed values: ACTIVE, PENDING 1.2.4 - "status"(string) - Topic status - active when one of the members is ACTIVE, otherwise PENDING. Allowed values: ACTIVE, PENDING 1.2.5 - "working_time_start"(string) - Working time start. Required. 1.2.6 - working_time_end"(string) - Working time end. Required. 1.2.7 - "working_days"(array) - List of weekdays the members in the topic are available. Required. 1.2.8 - "time_zone"(string) - Timezone specification. Required. 1.3 - "account_id" (string) - The account ID. Required. 1.4 - "sub_topics" (array[object]) - Sub topic within the sub-team's details. Required. "sub_topics" subdivides into: 1.4.1 - "name"(string) - Topic name. Required. 1.4.2 - "meetings duration"(object) - The meeting's duration in minutes. Required. 1.4.3 - members" (array[object]) - List of members. In subTopics are only allowed members presented in the main topic. "members" subdivides into: 1.4.3.1 - "name"(string) - Topic name. 1.4.3.2 - "email"(string) - Team member's email. Required. 1.4.3.3 - "provider"(string) - Team member email provider. Required. Allowed values: GOOGLE, OUTLOOK 1.4.3.4 - "status"(string) - Team member status - ACTIVE after the member has given access to his calendar, otherwise is PENDING. Allowed values: ACTIVE, PENDING 1.5. - "links"(object) |
| total_pages | integer | The total pages present. Required. |
| total | integer | The number of teams. Required. |
| count | integer | The count. Required. |
| page | integer | The page number. Required. |
| per_page | integer | The page size. Required. |
| _links | object | "_links" subdivides into: 1 - "self" (object) Required. 1.1 - "href" (string) - The link to the first page. Required. 2. - "next" (object) 2.1 - "href" (string) - The link to the last page. 3. - "prev" (object) Required. 3.1 - "href" (string) Required.1 - "first" (object) Required. 1.1 - "href" (string) Required. 4. - "last" (object) 2.1 - "href" (string) - The link to the last page. 5. - "prev" (object) 4.1 - "href" (string) - The link to the previous page.5 - "self" (object) 5.1 - "href" (string) - The link to the current page. |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.