Skip to content

Get a call sheet

Show module

GET/call-sheets/{id}callSheets.get

A call sheet listing call times for one scope node and date. Returns one call sheet with its `ETag`. A call sheet the caller may not see returns 404.

  • Requires the capability show.run_of_show.read.
  • OAuth scopes: show.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

callSheets.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the call sheet.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: CallSheet

callSheets.get: CallSheet
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the call sheet.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
daystring (date)YesDay the sheet covers; one sheet per project and day.
project_idstring (uuid)YesIdentifier of the project of the call sheet.
published_atstring (date-time) | nullYesWhen the call sheet was published, stamped by the database; set once by the publish action.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "day": "2026-10-08",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "published_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X GET "$XOS_BASE_URL/call-sheets/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.callSheets.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.call_sheets.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos call-sheets get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f