> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # List an organization's API clients > Lists an organization's API clients, newest first by default. Your API client must have access to the organization. ## OpenAPI ````yaml /api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/appclients openapi: 3.0.3 info: title: Identity version: 1.0.0 description: >- Portão 3 identity API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). 4 app groups run without the identity authorizer; publicPatterns enumerates every route they expose, except POST /auth/sign-in, documented with HTTP Basic for the API-client credentials flow. Confidence tiers: generated:typed=45 copied:manual=0 unknown=0. servers: - url: https://api.identity.v2.portao3.com.br/ description: production - url: https://api.identity.dev.3pers.com.br/ description: development security: [] tags: - name: Authentication - name: Current User - name: Custom Fields - name: API Clients - name: Users - name: Organizations - name: Groups - name: Realms paths: /realms/{realmId}/organizations/{organizationId}/appclients: get: tags: - API Clients summary: List an organization's API clients description: >- Lists an organization's API clients, newest first by default. Your API client must have access to the organization. operationId: getRealmsByRealmIdOrganizationsByOrganizationIdAppclients parameters: - name: realmId in: path required: true description: |- ID of your realm. Format: `UUID` schema: type: string format: uuid example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b - name: organizationId in: path required: true description: |- ID of the organization whose API clients you want to list. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: next in: query required: false description: >- Cursor returned as `next` by the previous page. Omit for the first page. schema: type: string example: NmEzZjljMjFlNGIwN2Q1YThjMTJmM2U5 - name: limit in: query required: false description: Page size. schema: default: 15 type: integer minimum: 1 example: 15 - name: order in: query required: false description: >- Sort direction by creation date (case-insensitive): `DESC` newest first, `ASC` oldest first. schema: default: DESC type: string enum: - ASC - DESC example: DESC - name: status in: query required: false description: >- Only API clients in this status. Omit to list active and deactivated ones alike. schema: type: string enum: - ACTIVE - DEACTIVATED example: ACTIVE - name: description in: query required: false description: >- Only API clients whose `description` or `clientId` contains this text (case-insensitive). schema: type: string maxLength: 200 example: ERP - name: startDate in: query required: false description: >- Only API clients created at or after this instant (ISO 8601 date or date-time). schema: type: string example: '2026-10-01T00:00:00.000Z' - name: endDate in: query required: false description: >- Only API clients created at or before this instant (ISO 8601 date or date-time). schema: type: string example: '2026-10-31T23:59:59.999Z' responses: '200': description: Successful response content: application/json: schema: type: object properties: next: type: string nullable: true description: >- Cursor for the next page: send it as the `next` query parameter. `null` on the last page. example: NmEzZjljMjFlNGIwN2Q1YThjMTJmM2U5 items: type: array items: type: object properties: id: type: string description: >- ID of the API client. Use it to deactivate the client. example: 43230779-2cfb-4525-a40c-77fbf15e68f0 format: uuid clientId: type: string description: >- Public identifier of the API client. Send it, with the client secret, to `POST /auth/sign-in` to get an access token. example: prod-client-v2 description: type: string description: Display name of the API client. example: ERP Integration realm: type: string description: ID of the realm the API client belongs to. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organizations: type: array items: type: object properties: id: type: string description: ID of the organization. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid level: type: string enum: - ADMIN - USER - APP_CLIENT description: >- Access level the API client holds in the organization. API clients are created as organization admins. example: ADMIN required: - id description: An organization the API client can act on. description: Organizations the API client can act on. status: type: string enum: - ACTIVE - DEACTIVATED description: >- `ACTIVE` clients can authenticate. `DEACTIVATED` clients can no longer authenticate; deactivation is permanent. example: ACTIVE createdAt: type: string description: When the API client was created. example: '2026-10-13T18:43:50.746Z' format: date-time updatedAt: type: string description: >- When the API client last changed (for example, when it was deactivated). example: '2026-10-13T18:43:50.746Z' format: date-time createdBy: type: string description: >- ID of the user or API client that created this API client. example: f1235202-71e0-49ef-a8ba-939b8d3ec945 format: uuid updatedBy: type: string description: >- ID of the user or API client that last changed this API client. example: f1235202-71e0-49ef-a8ba-939b8d3ec945 format: uuid required: - id - clientId - description - realm - organizations - status - createdAt - updatedAt - createdBy - updatedBy description: >- An API client: a machine credential for calling Portão 3 APIs. description: The API clients on this page. required: - next - items description: A page of API clients. '403': description: >- `FORBIDDEN_APP_CLIENT` — Your API client doesn't have access to this organization. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - FORBIDDEN_APP_CLIENT description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - IDENTITY description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: FORBIDDEN_APP_CLIENT origin: IDENTITY message: >- You do not have permission to perform this action on this app client '422': description: >- `BAD_REQUEST` — A path or query parameter is invalid; `fields` lists each one. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - IDENTITY description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BAD_REQUEST origin: IDENTITY message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: limit message: 'Too small: expected number to be >=1' code: LIMIT_MIN ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.