Skip to main content
curl -X GET "https://api.chargefy.io/v1/organizations?limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "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"
}
Retorna uma página de organizações no envelope de lista canônico.

​
Autenticação

CredencialRetorno
JWT de usuárioOrganizações acessíveis ao usuário, incluindo vínculos permitidos por plataforma.
API key da organizaçãoA própria organização da key.
API key da plataformaOrganizações conectadas ativas daquela plataforma.

​
Parâmetros de query

​
limit
integer
default:"10"
Itens por página. Máximo 100.
​
starting_after
string
Cursor para buscar a próxima página depois do ID informado.
​
ending_before
string
Cursor para buscar a página anterior antes do ID informado.
curl -X GET "https://api.chargefy.io/v1/organizations?limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"

​
Resposta

​
object
string
Sempre "list".
​
data
array
Lista de objetos organization.
​
has_more
boolean
true quando existe próxima página.
​
url
string
Caminho canônico da coleção: /v1/organizations.
{
  "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"
}