Auth & Identidade
Gestão de Acesso
Faturamento
Listar Organizacoes
curl --request GET \
--url https://api.example.com/organizations \
--header 'Authorization: <authorization>'{
"data": [
{
"organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
"billingThresholdId": "019525fd-a068-7e7c-d4f0-6a8b0c2e4f6c",
"subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
"iamExternalRef": "org_workos_abc123",
"billingExternalRef": "cus_stripe_abc123",
"name": "Acme Inc",
"email": "billing@acme.com",
"currency": "BRL",
"phone": "+5511999999999",
"address": {
"line1": "Av Paulista 1000",
"line2": null,
"city": "Sao Paulo",
"state": "SP",
"postalCode": "01310-100",
"country": "BR"
},
"taxId": "12345678000100",
"taxType": "CNPJ",
"offboardingStatus": "ACTIVE",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-03-01T10:00:00.000Z"
}
],
"meta": { "page": 1, "limit": 20, "totalItems": 50, "totalPages": 3 }
}
Organizations
Listar Organizacoes
Recuperar uma lista paginada de todas as organizacoes com opcoes de busca e ordenacao.
GET
/
organizations
Listar Organizacoes
curl --request GET \
--url https://api.example.com/organizations \
--header 'Authorization: <authorization>'{
"data": [
{
"organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
"billingThresholdId": "019525fd-a068-7e7c-d4f0-6a8b0c2e4f6c",
"subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
"iamExternalRef": "org_workos_abc123",
"billingExternalRef": "cus_stripe_abc123",
"name": "Acme Inc",
"email": "billing@acme.com",
"currency": "BRL",
"phone": "+5511999999999",
"address": {
"line1": "Av Paulista 1000",
"line2": null,
"city": "Sao Paulo",
"state": "SP",
"postalCode": "01310-100",
"country": "BR"
},
"taxId": "12345678000100",
"taxType": "CNPJ",
"offboardingStatus": "ACTIVE",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-03-01T10:00:00.000Z"
}
],
"meta": { "page": 1, "limit": 20, "totalItems": 50, "totalPages": 3 }
}
Requer permissao
organizations:read.Headers
Bearer token.
Parametros de Query
Numero da pagina.
Resultados por pagina.
Buscar por nome ou email.
Campo de ordenacao.
Direcao da ordenacao.
Resposta
Lista de organizacoes.
Show propriedades da organizacao
Show propriedades da organizacao
UUID da organizacao.
ID do limite de faturamento.
O ID da assinatura ativa.
Referencia externa do provedor de identidade.
Referencia externa do provedor de pagamento.
Nome da organizacao.
Email de billing.
Codigo da moeda.
Numero de telefone.
Endereco de billing.
Identificador fiscal.
Tipo de identificador fiscal.
O status de offboarding da organizacao.
Timestamp de criacao.
Timestamp da ultima atualizacao.
{
"data": [
{
"organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
"billingThresholdId": "019525fd-a068-7e7c-d4f0-6a8b0c2e4f6c",
"subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
"iamExternalRef": "org_workos_abc123",
"billingExternalRef": "cus_stripe_abc123",
"name": "Acme Inc",
"email": "billing@acme.com",
"currency": "BRL",
"phone": "+5511999999999",
"address": {
"line1": "Av Paulista 1000",
"line2": null,
"city": "Sao Paulo",
"state": "SP",
"postalCode": "01310-100",
"country": "BR"
},
"taxId": "12345678000100",
"taxType": "CNPJ",
"offboardingStatus": "ACTIVE",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-03-01T10:00:00.000Z"
}
],
"meta": { "page": 1, "limit": 20, "totalItems": 50, "totalPages": 3 }
}
Exemplos de Codigo
curl https://api.awsales.io/admin/organizations?page=1&limit=20 \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Codigos de Erro
| Status | Codigo | Descricao |
|---|---|---|
400 | validation_error | Entrada invalida ou campos obrigatorios ausentes |
401 | unauthorized | Autenticacao ausente ou invalida |
403 | forbidden | Permissoes insuficientes |
500 | internal_server_error | Ocorreu um erro inesperado |
⌘I
Assistant
Responses are generated using AI and may contain mistakes.