> ## 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.

# Consultar plataforma

> Confirma a identidade e o ambiente da plataforma autenticada pela API key.

<Warning>
  Este recurso é exclusivo de **Chargefy for Platforms**, produto usado para
  operar os pagamentos de suas organizações filhas.
</Warning>

Use a API key com escopo `platform_admin`. A consulta funciona mesmo antes de
criar a primeira organização filha. O ID deve pertencer à plataforma da chave;
outro ID retorna `404`, sem revelar dados de outra plataforma. Não envie o header
`Organization`. O ambiente vem da chave, não de um parâmetro da requisição.

<ParamField path="id" type="string" required>
  ID da plataforma (`plat_*`).
</ParamField>

<RequestExample>
  ```bash cURL theme={"theme":"css-variables"}
  curl "https://api.chargefy.io/v1/platforms/plat_5Nq8rT2wX7mK4pV9" \
    -H "Authorization: Bearer {{API_KEY}}"
  ```
</RequestExample>

## Resposta

<ResponseField name="id" type="string">ID da plataforma.</ResponseField>
<ResponseField name="object" type="string">Sempre `platform`.</ResponseField>
<ResponseField name="created_at" type="string">Data de criação em ISO 8601.</ResponseField>
<ResponseField name="livemode" type="boolean">`true` para chave de produção; `false` para teste.</ResponseField>
<ResponseField name="metadata" type="object">Objeto vazio; esta consulta não edita metadata.</ResponseField>
<ResponseField name="name" type="string">Nome de exibição da plataforma.</ResponseField>
<ResponseField name="organization" type="string">Organização proprietária da plataforma.</ResponseField>
<ResponseField name="status" type="string">`active` ou `suspended`.</ResponseField>
<ResponseField name="updated_at" type="string | null">Última atualização em ISO 8601, quando disponível.</ResponseField>

<ResponseExample>
  ```json 200 theme={"theme":"css-variables"}
  {
    "id": "plat_5Nq8rT2wX7mK4pV9",
    "object": "platform",
    "created_at": "2026-10-06T12:00:00Z",
    "livemode": true,
    "metadata": {},
    "name": "Minha plataforma",
    "organization": "org_7Dk9mQ2vX5rT8pWN",
    "status": "active",
    "updated_at": null
  }
  ```
</ResponseExample>

| HTTP | Quando ocorre |
| - | - |
| `400` | Header `Organization` enviado. |
| `401` | Chave inválida, expirada ou revogada. |
| `403` | Chave sem escopo `platform_admin`. |
| `404` | Plataforma ausente ou ID diferente daquele da chave. |
| `405` | Método diferente de `GET`. |
| `503` | Consulta temporariamente indisponível. |


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