Saltar al contenido

List representation rows

Módulo Identity

GET/representationsrepresentations.list

One party acting for another, with scopes and expiry. The artist accepts it. Returns a cursor page of representation rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad me.profile.write.
  • Alcances de OAuth: me.
  • Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
  • Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

representations.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de Representation

representations.list: 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.
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/representations" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.representations.listAll()) {
  console.log(row);
}
for row in xos.representations.list_all():
    print(row)
xos representations list --all