Get a representation
Identity module
GET/representations/{id}representations.get
One party acting for another, with scopes and expiry. The artist accepts it. Returns one representation with its `ETag`. A representation the caller may not see returns 404.
- Requires the capability me.profile.write.
- OAuth scopes: me.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the representation. |
| 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: Representation
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the representation. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| representative_person_id | string (uuid) | null | Yes | Identifier of the representative. |
| artist_person_id | string (uuid) | Yes | Identifier of the represented artist. |
| scopes | array of RepresentationScope | Yes | Delegated scopes, stored as junction rows. |
| expires_on | string (date) | Yes | Expiry. |
| accepted_at | string (date-time) | null | Yes | When the artist accepted. |
| revoked_at | string (date-time) | null | Yes | When the artist or the account revoked it. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"representative_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"artist_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scopes": [
"Offers",
"Advance"
],
"expires_on": "2026-10-08",
"accepted_at": "2026-10-08T14:30:00Z",
"revoked_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/representations/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.representations.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.representations.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos representations get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f