User Call Settings - List of Schedules for a Person

List of Schedules for a Person

List schedules for a person in an organization.

Schedules are used to support calling features and can be defined at the location or person level. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. holidays schedules define exceptions to normal business hours by defining one or more events.

This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.

GET/v1/people/{personId}/features/schedules

URI Parameters

personId

stringrequired

Unique identifier for the person.

Query Parameters

orgId

string

ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

start

number

Specifies the offset from the first result that you want to fetch.

Default: 0

max

number

Specifies the maximum number of records that you want to fetch.

Default: 2000

name

string

Specifies the case insensitive substring to be matched against the schedule names. The maximum length is 40.

Default: null

type

string

Specifies the schedule event type to be matched on the given type.

Default: null

Response Properties

schedules

array[ScheduleShortDetails]

Indicates a list of schedules.

string

Identifier for a schedule.

name

string

Name for the schedule.

type

ScheduleType

Indicates the schedule type whether businessHours or holidays.

businessHours

string

Indicates the schedule type that specifies the business or working hours during the day.

holidays

string

Indicates the schedule type that specifies the day when your organization is not open.

Response Codes

The list below describes the common success and error responses you should expect from the API.

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/v1/people//features/schedules{?orgId,start,max,name,type}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
start
number
Specifies the offset from the first result that you want to fetch.
max
number
Specifies the maximum number of records that you want to fetch.
name
string
Specifies the case insensitive substring to be matched against the schedule names. The maximum length is 40.
type
string
Specifies the schedule event type to be matched on the given type.

https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/schedules?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&start=0&max=100&name=dallas&type=businessHours

200 / OK

{
  "schedules": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ",
      "name": "Dallas_Office_Hours",
      "type": "businessHours"
    }
  ]
}