Get a custom object record
Platform module
GET/objects/{object_key}/{id}objects.get
A record of a custom object. Values are stored one row per field, never as JSON. Returns one custom object record with its `ETag`. A custom object record the caller may not see returns 404.
- Requires the capability work.record.read.
- OAuth scopes: work.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| object_key | string | Yes | The `object_key` path segment.Constraints: length 1 to any |
| id | string (uuid) | Yes | Identifier of the custom object record. |
| fields | Fields | No | Sparse 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: CustomObjectRecord
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the custom object record. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| title | string | Yes | Record title.Constraints: length 1 to 300 |
| values | object | Yes | Field values keyed by field key. Stored normalized in `custom_object_values`. |
| custom_object_type_id | string (uuid) | Yes | Identifier of the object type the record is an instance of. |
{
"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",
"title": "Harbor Lounge Activation",
"values": {
"activation_date": "2026-10-08"
},
"custom_object_type_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/objects/sponsor_activation/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.objects.get("sponsor_activation", "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.objects.get("sponsor_activation", "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos objects get sponsor_activation 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f