Skip to navigation

Get handoff

View as Markdown

Returns your organization’s handoff. There is one per organization, so there is no id.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Response

Your organization's handoff
category_settingslist of objectsOptional
Handoff categories. Handoff items are grouped into categories by display key.
item_settingslist of objectsOptional

Handoff items: the individual handoff options shown to users.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error