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

> Lists the organization's products and services, newest first.

Any member of the organization can list products. Narrow the list with `name`, `skuCode`, `status`, `type` and a creation date range (`startDate`, `endDate`), sort it with `orderBy` and `order`, and page through it with `limit` and `next`: each page answers the cursor of the following one as `next`, which is `null` on the last page.

`name` matches the products whose name or SKU code contains the text, ignoring case, while `skuCode` and `type` match by contained text too. The date range is on the creation date and both ends are inclusive; a date with no time means 00:00 UTC of that day.


## OpenAPI

````yaml /api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products
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 <token>) 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}/products:
    get:
      tags:
        - Products
      summary: List products
      description: Lists the organization's products and services, newest first.
      operationId: getRealmsByRealmIdOrganizationsByOrganizationIdProducts
      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 products 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 products whose name or SKU code contains this text
            (case-insensitive).
          schema:
            type: string
            minLength: 1
            maxLength: 56
          example: consultoria
        - name: skuCode
          in: query
          required: false
          description: Only products whose SKU code contains this text (case-insensitive).
          schema:
            type: string
            minLength: 1
            maxLength: 50
          example: CONS-LOG
        - name: status
          in: query
          required: false
          description: Only products in this status.
          schema:
            type: string
            enum:
              - ACTIVE
              - DEACTIVATED
          example: ACTIVE
        - name: type
          in: query
          required: false
          description: >-
            Only products whose type contains this text (case-insensitive):
            `PRODUCT` or `SERVICE`.
          schema:
            type: string
            minLength: 1
            maxLength: 50
          example: SERVICE
        - name: startDate
          in: query
          required: false
          description: >-
            Only products created at or after this moment, in ISO 8601. A date
            with no time means 00:00 UTC of that day. It can't be after
            `endDate`.
          schema:
            type: string
          example: '2026-10-01T00:00:00.000Z'
        - name: endDate
          in: query
          required: false
          description: >-
            Only products created at or before this moment, in ISO 8601. A date
            with no time means 00:00 UTC of that day, so `2026-10-31` leaves out
            products created later on the 31st: send `2026-10-31T23:59:59.999Z`
            to include the whole day.
          schema:
            type: string
          example: '2026-10-31T23:59:59.999Z'
        - name: limit
          in: query
          required: false
          description: Page size. Defaults to 15.
          schema:
            default: 15
            type: integer
          example: 15
        - 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:
              - name
              - value
              - createdAt
          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 product.
                          example: 9b2f6c1e-3d4a-4f7b-8e21-5a6c7d8e9f01
                        realmId:
                          type: string
                          description: ID of the realm the product belongs to.
                          example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
                          format: uuid
                        organizationId:
                          type: string
                          description: ID of the organization the product belongs to.
                          example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
                          format: uuid
                        name:
                          type: string
                          description: Name of the product or service.
                          example: Consultoria em logística
                        description:
                          type: string
                          description: Free-text description. Empty when none was given.
                          example: >-
                            Hora técnica de consultoria em logística e
                            roteirização.
                        value:
                          type: number
                          description: 'Price in centavos: `15000` is R$ 150,00.'
                          example: 15000
                        skuCode:
                          type: string
                          nullable: true
                          description: >-
                            Your own stock-keeping code. Absent, or `null`, when
                            none was given.
                          example: CONS-LOG-001
                        type:
                          type: string
                          description: >-
                            `PRODUCT` for a physical good or `SERVICE` for a
                            service. Any other text a client stored is kept as
                            sent.
                          example: SERVICE
                        status:
                          type: string
                          enum:
                            - ACTIVE
                            - DEACTIVATED
                          description: >-
                            `ACTIVE`, or `DEACTIVATED` once the product was
                            retired.
                          example: ACTIVE
                        createdAt:
                          type: string
                          description: When the product was created.
                          example: '2026-10-02T14:03:11.000Z'
                          format: date-time
                        updatedAt:
                          type: string
                          description: When the product was last changed.
                          example: '2026-10-05T09:30:00.000Z'
                          format: date-time
                      required:
                        - id
                        - realmId
                        - organizationId
                        - name
                        - description
                        - value
                        - type
                        - status
                      description: A product or service of the organization's catalog.
                    description: >-
                      Products, 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 products.
        '422':
          description: >-
            `BAD_REQUEST` — A path or query parameter is invalid, such as a
            `startDate` that is not a date or comes after `endDate`; `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: >-
                            `<FIELD>_<REASON>` — 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 <=56 characters'
                    code: NAME_MAX

````

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