get https://api.talkdeskapp.com/industries-scheduler/appointments
Get appointments associated with an account.
Scope
industries-scheduler-appointment: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 appointment ID. Required. 1.2 - "account_id"(string) - The account ID associated with the team. 1.3 - "team_member"(object) - The team member information. Required. "team_member" subdivides into: 1.3.1 - "name"(string) - The name of the team member. Required. 1.3.2 - "email"(string) - The email address of the team member. Required. 1.3.3 - "status"(string) The status of the team member. Allowed values: ACTIVE PENDING 1.3.4 - provider" (array[object]) - The email provider used by the team member's email address. Allowed values: OUTLOOK GOOGLE. 1.4. - calendar_event_id" (string) - The calendar event ID. Required. 1.5 - "start"(integer) - The start time of the appointment in UTC timestamp (milliseconds). Required. 1.6. - "start"(integer) - The end time of the appointment in UTC timestamp (milliseconds). Required. 1.7 - "team_id"(string) - The ID of the team associated with the appointment. Required. <= 50 characters 1.8 - "client_name"(string) - The name of the client associated with the appointment. <= 50 characters 1.9 "client_email"(string) - The email of the client associated with the appointment. <= 50 characters 1.10 - "notes"(string) - The notes associated with the appointment. <= 50 characters |
| 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. 4. - "first" (object) 4.1 - "href" (string) 5. - "last" (object) 5.1 - "href" (string) |
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.