Schedules

Advertencia

Esta página aún no se encuentra traducida al español.

Overview

Schedules are automated tasks that can run on a scheduled date and time, either once or recurrently.

additional resources

These are just some of the most basic API requests. For a complete list of endpoints, consult our API documentation on Swagger.

Get All Schedules

Returns all the schedules that exist within the company.

GET /schedules

Endpoint URL

https://www.cotalker.com/api/v2/schedules

Headers

Header	Description	Required	Values
Admin	Authorizes access to the data.	Required	true
Authorization	Sends your access token to make an API request. Click here to see how to obtain an access token.	Required	Bearer $ACCESS_TOKEN

Query Parameters

Parameter	Description	Type	Required	Notes
limit	Limits the amount of schedules returned in the response.	number	Optional	By default, the limit is set to 10.
page	Makes the response display data from the indicated page number.	number	Optional	Best used in combination with the "limit" parameter.
count	Adds the counter field with the total amount of schedules.	boolean	Optional
code	Returns the schedule with the indicated code name.	string	Optional	The schedule's code is found in the COTSchedule data model.

Request Sample

curl --location --request GET 'https://www.cotalker.com/api/v2/schedules' \
--header 'admin: true' \
--header 'Authorization: Bearer $ACCESS_TOKEN'

Response Sample

Responses follow the COTSchedule data model.

---