> ## 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 suppliers > Lists the organization's suppliers, newest first. Only organization admins can list suppliers. Narrow the list with `name`, `document` and `status`, sort it with `orderBy` and `order`, and page through it with `limit` (25 by default) and `next`: each page answers the cursor of the following one as `next`, which is `null` on the last page. `name` matches the suppliers whose name or trade name contains the text, ignoring case, and `document` those whose document contains the characters. `status` is an exact match. ## OpenAPI ````yaml /api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers 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}/suppliers: get: tags: - Suppliers summary: List suppliers description: Lists the organization's suppliers, newest first. operationId: getRealmsByRealmIdOrganizationsByOrganizationIdSuppliers 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 suppliers you want to list. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: name in: query required: false description: >- Only suppliers whose name or trade name contains this text (case-insensitive). schema: type: string minLength: 1 maxLength: 50 example: boa viagem - name: document in: query required: false description: >- Only suppliers whose document contains these letters and digits (case-insensitive). Send it with no dots, slashes or hyphens. schema: type: string pattern: ^[A-Za-z0-9]+$ example: '112223' - name: status in: query required: false description: Only suppliers in this status. schema: type: string enum: - ACTIVE - DEACTIVATED example: ACTIVE - name: limit in: query required: false description: Page size. Defaults to 25. schema: default: 25 type: integer example: 25 - name: next in: query required: false description: >- Cursor returned as `next` by the previous page. Omit it for the first page. schema: type: string example: NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy - name: order in: query required: false description: >- Sort direction. Defaults to `DESC`: newest first when sorting by `createdAt`. schema: default: DESC type: string enum: - ASC - DESC example: DESC - name: orderBy in: query required: false description: Field to sort by. Defaults to `createdAt`. schema: default: createdAt type: string enum: - createdAt - updatedAt - name - tradingName - document example: createdAt responses: '200': description: Successful response content: application/json: schema: type: object properties: items: type: array items: type: object properties: id: type: string description: ID of the supplier. example: 5f0c7d2a-91b4-4e6f-8a13-c2d4e6f80b17 realm: type: string description: ID of the realm the supplier belongs to. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organization: type: string description: ID of the organization the supplier belongs to. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid name: type: string description: Name of the supplier. example: Transportadora Boa Viagem Ltda tradingName: type: string description: >- Trade name of the supplier. Absent when none was given. example: Boa Viagem Transportes document: type: string description: >- CPF or CNPJ of the supplier, with no punctuation. A CNPJ with letters is returned in upper case. example: '11222333000181' documentType: type: string enum: - CPF - CNPJ description: >- `CPF` when the supplier is a person, `CNPJ` when it is a company. example: CNPJ email: type: string description: E-mail address of the supplier. example: financeiro@boaviagem.example.com phoneNumber: type: string description: >- Phone number of the supplier in international format. example: '+5534984325252' address: type: object properties: street: type: string description: Street name. example: Rua das Flores number: type: string description: Street number. example: '100' neighborhood: type: string description: Neighborhood. example: Centro city: type: string description: City. example: Uberlândia state: type: string description: State, as its two-letter abbreviation. example: MG postalCode: type: string description: Postal code (CEP) as `00000-000`. example: 38400-000 complement: type: string description: >- Complement such as a suite or a floor. Absent when none was given. example: Sala 2 required: - street - number - neighborhood - city - state - postalCode description: Address of the supplier. status: type: string enum: - ACTIVE - DEACTIVATED description: >- `ACTIVE`, or `DEACTIVATED` once the supplier was deactivated. example: ACTIVE pixKey: type: string description: >- PIX key to pay the supplier. Absent when none was given. example: financeiro@boaviagem.example.com pixKeyType: type: string enum: - PHONE - EMAIL - CPF - CNPJ - EVP description: >- Type of `pixKey`: `PHONE`, `EMAIL`, `CPF`, `CNPJ` or `EVP` (a random key). Absent when there is no PIX key. example: EMAIL createdBy: type: string description: ID of the user who registered the supplier. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid createdAt: type: string description: When the supplier was registered. example: '2026-10-02T14:03:11.000Z' format: date-time updatedAt: type: string description: When the supplier was last changed. example: '2026-10-05T09:30:00.000Z' format: date-time required: - id - realm - organization - name - document - documentType - email - phoneNumber - status description: 'A supplier of the organization: someone you pay.' description: >- Suppliers, in the order you asked for (newest first by default). next: type: string nullable: true description: Cursor for the next page. `null` on the last page. example: NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy required: - items - next description: A page of suppliers. '403': description: '`FORBIDDEN_SUPPLIER` — You are not an admin of 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_SUPPLIER 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_SUPPLIER origin: REGISTRY message: You do not have permission to perform this action on supplier '422': description: >- `BAD_REQUEST` — A path or query parameter is invalid, such as an unknown `status` or `orderBy`; `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: name message: 'Too big: expected string to have <=50 characters' code: NAME_MAX ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.