TAtalkdesk
Appointment scheduling service

Retrieve flat appointment scheduling

Retrieve flat appointment scheduling by provider, service type or location.

get/appointment-scheduling/virtual-agent/schedule-settings

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/appointment-scheduling/virtual-agent/schedule-settings
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: appointment-scheduling-va:read

Query parameters

provider_idstring

Id of the provider.

service_type_idstring

Id of the service type.

location_idstring

Id of the location.

service_type_descriptionstring

Service type description. Only applies if service_type_id is not specified.

provider_descriptionstring

Provider description. Only applies if provider_id is not specified.

location_descriptionstring

Location description. Only applies if location_id is not specified.

office_addressstring

Office address. Only applies if location_id is not specified.

office_citystring

Office City. Only applies if location_id is not specified.

office_statestring

Office State. Only applies if location_id is not specified.

office_zip_codestring

Office zip code. Only applies if location_id is not specified.

office_phone_numberstring

Office Phone Number. Only applies if location_id is not specified.

genderstring

The sex of the physician. Only applies if provider_id is not specified.

languagestring

The language spoken by physician. Only applies if provider_id is not specified.

Response

OK

provider_idstring required

The provider id, if this field doesn't exist, it returns an empty string.

provider_descriptionstring required

The provider description, if this field doesn't exist, it returns an empty string.

photo_urlstring required

The provider photo url, only URL starting with https:// and ending with .jpg are supported, and the field only returns intermediate paths, e.g. https://test/A.jpg returns test/A, if this field doesn't exist, it returns an empty string.

genderstring required

The sex of the physician, if this field doesn't exist, it returns an empty string.

languagestring required

The language spoken by physician, if this field doesn't exist, it returns an empty string.

service_type_idstring required

The service type id, if this field doesn't exist, it returns an empty string.

service_type_descriptionstring required

The service type description, if this field doesn't exist, it returns an empty string.

location_idstring required

The location id, if this field doesn't exist, it returns an empty string.

location_descriptionstring required

The location description, if this field doesn't exist, it returns an empty string.

office_addressstring required

The office address, if this field doesn't exist, it returns an empty string.

office_citystring required

The office city, if this field doesn't exist, it returns an empty string.

office_statestring required

The office state, if this field doesn't exist, it returns an empty string.

office_zip_codestring required

The office zip code, if this field doesn't exist, it returns an empty string.

office_phone_numberstring required

The office phone number, if this field doesn't exist, it returns an empty string.

totalinteger required

The total combinations found.

Changes

No recorded changes to this operation across all 2 revisions of this API.