Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
staff
GET /staff/{organizationId}/assignment/{externalId}
Description
Retrieve all the contacts by staffed calendar external ID within an organization
based on a date and time.
Return type
a calendar and collection of staff assignments
Parameters
Name | Required? | Data Type? | Description |
---|---|---|---|
credentials | y | string | Basic Authorization header. |
organizationId | y | long | The ID of the organization that owns this resource. |
externalId | y | string | The external ID of this scheduling calendar. |
shiftName | n | string | The name of the shift. If not provided, all shifts will be returned. |
from | n | string | The beginning date time range, leaving empty will use the current time. Examples: "2017-06-01", "2017-06-01 10:00" |
to | n | string | The ending date time range, leaving empty will use the current time. |
Error Status Codes
HTTP Status Code | Reason |
---|---|
400 | Missing or invalid request input. |
401 | Invalid or missing credentials. |
500 | Internal Error |
404 | Resource not found |
Example Response