solarOS Organization API

Organization API

List Time Blocks

Lists same-organization Time Blocks — a Team Member's unavailability such as PTO, sick time, or training — ordered by start. Filter by teamMemberId, or by endsAfter to get blocks that have not ended yet. Required scope: time_blocks:read.

/api/v1/time-blocks

Lists same-organization Time Blocks — a Team Member's unavailability such as PTO, sick time, or training — ordered by start. Filter by teamMemberId, or by endsAfter to get blocks that have not ended yet. Required scope: time_blocks:read.

List Time Blocks. Use an organization API key with time_blocks:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

time_blocks:read

Parameters

NameInTypeDescription
teamMemberIdquerystringOnly Time Blocks for this Team Member.
endsAfterquerystringOnly Time Blocks that end after this ISO 8601 date-time.
limitqueryintegerMaximum records to return. Defaults to 50 and is capped at 100.
cursorquerystringOpaque record cursor from the previous response meta.nextCursor value.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Time Block list envelope

#/components/schemas/TimeBlockListEnvelope

400

endsAfter is not a date-time

#/components/schemas/OrgApiError

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

403

Missing required scope: time_blocks:read

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

400 endsAfter is not a date-time401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: time_blocks:read429 Rate limit exceeded

Static examples

curl -X GET "$SOLAROS_BASE_URL/api/v1/time-blocks" \
  -H "Authorization: Bearer $SOLAROS_API_KEY"