> ## 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 customers > Lists the customers of an organization, 25 per page and oldest first by default. Page with `limit` and `next`: pass the `next` cursor of one page to get the following one; the last page has no `next`. Sort with `order` and `orderBy`. `search` looks for the text, case-insensitively, anywhere in the customer's name, trade name or document, and in the text values of its custom fields (a number or yes/no value is never matched). A term with at least one letter is searched as typed. A term with no letter keeps only its digits, so a CPF typed as `529.982.247-25` finds the stored `52998224725`, and `10-20` is searched as `1020`. `documents` looks up up to 100 documents at once, comma-separated: `?documents=52998224725,11144477735` (repeating the parameter works too). A repeated document counts once, more than 100 is rejected and a blank value is ignored. It combines with `search`, `status` and `documentType`, but it answers every match in one response, oldest first and with no `next`: `limit`, `next`, `order` and `orderBy` don't apply. ## OpenAPI ````yaml /api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer openapi: 3.0.3 info: title: Registry version: 1.0.0 description: >- Portão 3 registry 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). Confidence tiers: generated:typed=37 copied:manual=0 unknown=0. servers: - url: https://api.registry.v2.portao3.com.br/ description: production - url: https://api.registry.dev.3pers.com.br/ description: development security: [] tags: - name: Customers - name: Companies - name: People - name: Products - name: Suppliers paths: /realms/{realmId}/organizations/{organizationId}/customer: get: tags: - Customers summary: List customers description: >- Lists the customers of an organization, 25 per page and oldest first by default. operationId: getRealmsByRealmIdOrganizationsByOrganizationIdCustomer 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 customers you want to list. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: search in: query required: false description: >- Free-text search over the customer's name, trade name, document and the text values of its custom fields (case-insensitive, any part of the text). schema: type: string example: souza - name: status in: query required: false description: |- Only customers in one of these statuses. --- Example (comma-separated list): `?status=ACTIVE,DEACTIVATED` schema: type: array items: type: string enum: - ACTIVE - DEACTIVATED style: form explode: false - name: documentType in: query required: false description: >- Only customers whose document is of one of these kinds: `CPF` (people) or `CNPJ` (companies). --- Example (comma-separated list): `?documentType=CPF,CNPJ` schema: type: array items: type: string enum: - CPF - CNPJ style: form explode: false - name: documents in: query required: false description: >- Only the customers with these documents (exact match, CPF or CNPJ without formatting). --- Example (comma-separated list): `?documents=52998224725,11144477735` schema: minItems: 1 maxItems: 100 type: array items: type: string minLength: 1 style: form explode: false - name: order in: query required: false description: 'Sort direction: `ASC` (oldest first, by default) or `DESC`.' schema: default: ASC type: string enum: - ASC - DESC example: DESC - name: orderBy in: query required: false description: Name of the customer field to sort by. Defaults to `createdAt`. schema: default: createdAt type: string example: name - name: limit in: query required: false description: Page size. Defaults to 25. schema: default: 25 type: number example: 25 - name: next in: query required: false description: >- Cursor returned as `next` by the previous page. Omit it to get the first page. schema: type: string example: NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy responses: '200': description: Successful response content: application/json: schema: type: object properties: next: type: string description: >- Cursor for the next page: pass it as `next` to get it. Absent on the last page, and when the list was filtered by `documents`. example: NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy items: type: array items: type: object properties: id: type: string description: ID of the customer. example: 7f3b1c52-9e4a-4d1b-8a67-2c5d9f0e4b13 format: uuid address: type: object properties: street: type: string description: Street name. example: Rua das Flores number: type: string description: Street number (letters, digits and dashes). example: '123' complement: type: string description: >- Extra address detail, such as an apartment or suite. example: Apto 45 neighborhood: type: string description: Neighborhood. example: Centro city: type: string description: City. example: São Paulo state: type: string description: Two-letter code of the Brazilian state. example: SP postalCode: type: string description: Postal code (CEP), as `00000-000`. example: 01000-000 description: Postal address of the customer. example: street: Rua das Flores number: '123' complement: Apto 45 neighborhood: Centro city: São Paulo state: SP postalCode: 01000-000 name: type: string description: >- Name of the customer: a person's full name or a company's name. example: Ana Souza document: type: string description: >- Tax ID of the customer, without formatting: a CPF (11 digits) or a CNPJ (14 characters — the first 12 may be uppercase letters, the last 2 are digits). example: '52998224725' documentType: type: string description: >- Kind of `document`: `CPF` for 11 characters, `CNPJ` otherwise. example: CPF trandingName: type: string description: Trade name of a company customer. example: Souza Studio email: type: string description: E-mail address of the customer. example: ana.souza@example.com phoneNumber: type: string description: >- Phone number of the customer, in international format: `+` followed by digits. A few older records that could not be converted to this format are returned exactly as they were stored. example: '+5511999999999' createdAt: type: string format: date-time description: When the customer was created. example: '2026-03-14T12:30:00.000Z' createdBy: type: string description: >- ID of the user or API client that created the customer. The customer list does not include it. example: 9b2f4c1e-5d38-4a76-b0e1-3c8a7d2f6e45 hash: type: string description: >- Token that identifies the customer in the link of their portal page (`customerUrl`). example: c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f format: uuid customerUrl: type: string description: >- Link to the customer's portal page. It is built from the portal address and `hash`. example: >- https://portal.example.com/c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f status: type: string description: 'Status of the customer: `ACTIVE` or `DEACTIVATED`.' example: ACTIVE customFields: description: >- Values of the organization's custom fields for this customer, keyed by the field's `slug`. Absent, or `null`, when the customer has none. --- Example: `{"cost-center":"CC-1020"}` example: cost-center: CC-1020 type: object additionalProperties: {} nullable: true required: - id - documentType - customerUrl description: 'A customer: the person or company an organization bills.' description: The customers of this page. required: - items description: A page of customers. '403': description: '`FORBIDDEN_CUSTOMER` — You do not belong to the 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_CUSTOMER description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - REGISTRY 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_CUSTOMER origin: REGISTRY message: >- You do not have permission to perform this action on this resource (customer) '422': description: >- `BAD_REQUEST` — A path or query parameter is invalid, such as an unknown `status`, more than 100 `documents` or a `limit` that is not a number; `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: - REGISTRY 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: REGISTRY message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: documents message: 'Too big: expected array to have <=100 items' code: DOCUMENTS_MAX ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.