Saltar al contenido

Get a representation

Módulo Identity

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.

  • Requiere la capacidad me.profile.write.
  • Alcances de OAuth: me.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

representations.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the representation.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: Representation

representations.get: Representation
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the representation.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
representative_person_idstring (uuid) | nullSíIdentifier of the representative.
artist_person_idstring (uuid)SíIdentifier of the represented artist.
scopesarray of RepresentationScopeSíDelegated scopes, stored as junction rows.
expires_onstring (date)SíExpiry.
accepted_atstring (date-time) | nullSíWhen the artist accepted.
revoked_atstring (date-time) | nullSí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"
}

Ejemplos de código

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