solarOS Organization API

Organization API

Get one Time Block

Returns one same-organization Time Block with its Team Member's Salesforce Service Resource ID. Time Blocks are deleted outright, so 404 means the block no longer exists. Required scope: time_blocks:read.

/api/v1/time-blocks/{id}

Returns one same-organization Time Block with its Team Member's Salesforce Service Resource ID. Time Blocks are deleted outright, so 404 means the block no longer exists. Required scope: time_blocks:read.

Get one Time Block. 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
idrequiredpathstringTime Block identifier returned by the Organization API.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Time Block envelope

#/components/schemas/TimeBlockEnvelope

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

404

Not found

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: time_blocks:read404 Not found429 Rate limit exceeded

Static examples

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