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

# List Organizations

> Lista organizações.

Retorna uma página de organizações no envelope de lista canônico.

## Autenticação

| Credencial             | Retorno                                                                           |
| ---------------------- | --------------------------------------------------------------------------------- |
| JWT de usuário         | Organizações acessíveis ao usuário, incluindo vínculos permitidos por plataforma. |
| API key da organização | A própria organização da key.                                                     |
| API key da plataforma  | Organizações conectadas ativas daquela plataforma.                                |

## Parâmetros de query

<ParamField query="limit" type="integer" default="10">
  Itens por página. Máximo `100`.
</ParamField>

<ParamField query="starting_after" type="string">
  Cursor para buscar a próxima página depois do ID informado.
</ParamField>

<ParamField query="ending_before" type="string">
  Cursor para buscar a página anterior antes do ID informado.
</ParamField>

<RequestExample>
  ```bash cURL theme={}
  curl -X GET "https://api.chargefy.io/v1/organizations?limit=20" \
    -H "Authorization: Bearer {{API_KEY}}"
  ```
</RequestExample>

## Resposta

<ResponseField name="object" type="string">
  Sempre `"list"`.
</ResponseField>

<ResponseField name="data" type="array">
  Lista de objetos `organization`.
</ResponseField>

<ResponseField name="has_more" type="boolean">
  `true` quando existe próxima página.
</ResponseField>

<ResponseField name="url" type="string">
  Caminho canônico da coleção: `/v1/organizations`.
</ResponseField>

<ResponseExample>
  ```json 200 theme={}
  {
    "object": "list",
    "data": [
      {
        "id": "org_123",
        "object": "organization",
        "activation_status": null,
        "activation_status_updated_at": null,
        "avatar_url": null,
        "bank_account": null,
        "billing_additional_info": null,
        "billing_address": null,
        "billing_name": null,
        "branding_settings": {
          "accent_color": "#FF6B00",
          "border_style": "rounded",
          "brand_color": "#1B1B1B",
          "font_family": null,
          "theme": "light"
        },
        "created_at": "2026-05-16T14:09:27Z",
        "document": "12345678000190",
        "document_type": "cnpj",
        "email": "contato@meusite.com",
        "livemode": true,
        "metadata": {},
        "name": "Acme Ltda",
        "platform": null,
        "socials": [],
        "updated_at": null,
        "website": "https://meusite.com"
      }
    ],
    "has_more": false,
    "url": "/v1/organizations"
  }
  ```
</ResponseExample>