Contextos

1. Listar contextos

Retorna uma lista de todos os contextos de dados.

  • URL: /lighthouse/orgs/{org_id}/businesses/{business_id}/contexts

  • Método: GET

  • Descrição: Recupera uma lista paginada de contexts.

Query Params

Nome
Tipo
Obrigatório
Descrição

page

integer

Não

Número da página (padrão: 1)

page_size

integer

Não

Número de resultados por página (padrão: 10, max: 100)

search

string

Não

Chave utilizada como filtro de busca

Observações sobre os parâmetros

  • page_size: se o valor fornecido for maior que 100, será convertido automaticamente para o valor limite.

Exemplo de Requisição

curl -X GET https://api.piercloud.io/lighthouse/orgs/{org_id}/businesses/{business_id}/contexts \
     -H "Authorization: Bearer <access_token>"

Resposta de Sucesso (200 OK)

{
  "code": "success",
  "data": {
    "contexts": [
      {
        "id": "uuid",
        "name": "Amazon Web Services",
        "provider": "aws",
        "currency": "USD",
        "is_default": true,
        "business_id": "uuid"
      }
    ],
    "total": 1
  }
}

Resposta de Erro (400 Bad Request)

{
  "code": "bad-request/invalid-parameters",
  "message": "error message"
}

Resposta de Erro (401 Unauthorized)

{
  "code": "failed",
  "message": "invalid or expired token"
}

Resposta de Erro (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "Unable to give access to the user"
}

Last updated