> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unifokal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lê as tuplas de um objeto ou de um usuário, por cursor

> Filtre por object ou por user. Exige uma chave secreta criada COM o escopo fga:check (chaves sem restrição não o têm).



## OpenAPI

````yaml /api-reference/openapi.json get /fga/tuples
openapi: 3.1.0
info:
  title: UNIFOKAL API
  version: v1
  summary: >-
    Verificação de identidade: sessão criada no servidor, jornada no widget,
    resultado no webhook.
  description: >-
    A versão vive no caminho (/v1); não existe header de versão. Adição
    compatível (campo, módulo ou chave nova) NÃO sobe a versão: ignore o que não
    conhecer. Todo erro tem a forma { error, message }: o código é estável, a
    mensagem não. Ids são prefixo + ULID. Webhooks são assinados (HMAC SHA-256
    no header X-IDSAAS-Signature, janela de 300s; o segredo é SEU, mínimo 32
    caracteres) e o header x-idsaas-event carrega o tipo do evento.
  termsOfService: https://unifokal.com/termos
  contact:
    name: UNIFOKAL
    url: https://docs.unifokal.com/
servers:
  - url: https://api.unifokal.com/v1
security: []
externalDocs:
  description: >-
    Documentação completa em https://docs.unifokal.com/. Briefing para agentes
    de IA em https://unifokal.com/llms.txt.
  url: https://docs.unifokal.com/
paths:
  /fga/tuples:
    get:
      summary: Lê as tuplas de um objeto ou de um usuário, por cursor
      description: >-
        Filtre por object ou por user. Exige uma chave secreta criada COM o
        escopo fga:check (chaves sem restrição não o têm).
      operationId: readFgaTuples
      parameters:
        - name: object
          in: query
          required: false
          schema:
            type: string
            minLength: 3
            maxLength: 376
        - name: user
          in: query
          required: false
          schema:
            type: string
            minLength: 3
            maxLength: 376
        - name: relation
          in: query
          required: false
          schema:
            type: string
            pattern: ^[a-z][a-z0-9_]{0,49}$
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            maxLength: 2048
      responses:
        '200':
          description: Uma página de tuplas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FgaTupleList'
        '400':
          description: >-
            Códigos estáveis: validation_error, invalid_cursor. Ramifique pelo
            campo error, nunca pela mensagem.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorEnvelope'
                  - properties:
                      error:
                        enum:
                          - validation_error
                          - invalid_cursor
        '401':
          description: >-
            Códigos estáveis: invalid_api_key. Ramifique pelo campo error, nunca
            pela mensagem.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorEnvelope'
                  - properties:
                      error:
                        enum:
                          - invalid_api_key
        '403':
          description: >-
            Códigos estáveis: credential_type_not_allowed,
            organization_suspended, test_key_used_in_production,
            insufficient_scope, ip_not_allowed. Ramifique pelo campo error,
            nunca pela mensagem.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorEnvelope'
                  - properties:
                      error:
                        enum:
                          - credential_type_not_allowed
                          - organization_suspended
                          - test_key_used_in_production
                          - insufficient_scope
                          - ip_not_allowed
        '422':
          description: >-
            Códigos estáveis: fga_ref_invalid, fga_filter_required. Ramifique
            pelo campo error, nunca pela mensagem.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorEnvelope'
                  - properties:
                      error:
                        enum:
                          - fga_ref_invalid
                          - fga_filter_required
        '429':
          description: >-
            Códigos estáveis: rate_limited. Ramifique pelo campo error, nunca
            pela mensagem.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorEnvelope'
                  - properties:
                      error:
                        enum:
                          - rate_limited
      security:
        - secretKey: []
components:
  schemas:
    FgaTupleList:
      type: object
      required:
        - tuples
        - next_cursor
      properties:
        tuples:
          type: array
          items:
            $ref: '#/components/schemas/FgaTupleKey'
        next_cursor:
          type:
            - string
            - 'null'
    ErrorEnvelope:
      type: object
      description: >-
        Todo erro da API tem exatamente esta forma. O campo error é um código
        estável (contrato); message é texto livre e pode mudar sem aviso.
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: Código estável do erro. Ramifique por ele.
        message:
          type: string
          description: Texto explicativo. NÃO é contrato.
      additionalProperties: false
    FgaTupleKey:
      type: object
      required:
        - object
        - relation
        - user
      properties:
        object:
          type: string
        relation:
          type: string
        user:
          type: string
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: >-
        Chave secreta (unifokal_live_ em produção, unifokal_test_ no sandbox: 64
        hex mais CRC-32) no Authorization: Bearer. Só no seu servidor: nunca no
        browser ou app (o widget monta apenas com o id vs_ da sessão). Não
        existe chave publishable.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.