Saltar al contenido

Get a block

Módulo Identity

GET/blocks/{id}blocks.get

A person's block of another person or an organization (Section 4.5.6 Profile Privacy). It hides the blocker's profile from the blocked person and from every member of a blocked organization, and the blocked profile from the blocker. Memberships and engagements are not affected. Returns one block with its `ETag`. A block the caller may not see returns 404.

  • Requiere la capacidad me.account.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

blocks.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the block.
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: Block

blocks.get: Block
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the block.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
blocked_urnstringSíURN of the blocked person (urn:xpms:person:{id}) or organization (urn:xpms:organization:{id}).Restricciones: length 1 to 300
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "blocked_urn": "urn:xpms:person:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/blocks/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.blocks.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.blocks.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos blocks get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f