Integracao

[ESPEC] Listar pessoas

Especificacao — ainda nao implementado. Este endpoint esta publicado para acordo de contrato; chamadas retornam 404 ate a implementacao.

Listagem paginada com filtros. Use updatedSince para sincronizacao incremental e status=unlinked para encontrar quem se cadastrou no proprio espaco e ainda nao tem identidade no sistema de origem — essas pessoas acessam normalmente, mas os eventos delas ficam retidos ate receberem um identity.externalId.

get/api/v1/integration/persons

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/integration/persons
  • Auth: API key in header X-API-Key

Query parameters

documentstring

Filtra por numero de documento.

personType'employee' | 'contractor' | 'partner' | 'visitor'

Vinculo da pessoa com o espaco. employee colaborador proprio, contractor terceiro, partner parceiro, visitor visitante.

Example:employee
status'active' | 'leave' | 'terminated' | 'unlinked'
updatedSincestring date-time

Retorna apenas registros alterados a partir desta data (ISO 8601).

pageinteger
limitinteger

Headers

X-API-Keystring required

Chave de API do espaco, gerada no painel administrativo.

Example:k_9fA3…
X-Tenant-Slugstring required

Identificador do espaco (slug).

Example:matriz-sao-jose

Response

Lista de pessoas

Example response

{
  "items": [
    {
      "identity": {
        "externalId": "EMP-4521",
        "registration": "4521",
        "badgeCode": "0000004521",
        "companyCode": "1"
      },
      "personType": "employee",
      "access": {
        "validFrom": "2026-03-01T00:00:00.000Z",
        "allowedHours": {
          "start": "07:00",
          "end": "19:00",
          "days": [
            1,
            2,
            3,
            4,
            5
          ]
        }
      },
      "devices": [
        {
          "deviceName": "Catraca Portaria"
        }
      ],
      "attributes": {
        "matriculaInterna": "4521",
        "turno": "A"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.