Skip to main content
GET
Get a product
Any member of the organization can read a product. A product that belongs to another organization is not found.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the product belongs to.

Format: UUID

productId
string<uuid>
required

ID of the product (id in the product list).

Format: UUID

Response

Successful response

A product or service of the organization's catalog.

id
string
required

ID of the product.

Example:

"9b2f6c1e-3d4a-4f7b-8e21-5a6c7d8e9f01"

realmId
string<uuid>
required

ID of the realm the product belongs to.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organizationId
string<uuid>
required

ID of the organization the product belongs to.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

name
string
required

Name of the product or service.

Example:

"Consultoria em logística"

description
string
required

Free-text description. Empty when none was given.

Example:

"Hora técnica de consultoria em logística e roteirização."

value
number
required

Price in centavos: 15000 is R$ 150,00.

Example:

15000

type
string
required

PRODUCT for a physical good or SERVICE for a service. Any other text a client stored is kept as sent.

Example:

"SERVICE"

status
enum<string>
required

ACTIVE, or DEACTIVATED once the product was retired.

Available options:
ACTIVE,
DEACTIVATED
Example:

"ACTIVE"

skuCode
string | null

Your own stock-keeping code. Absent, or null, when none was given.

Example:

"CONS-LOG-001"

createdAt
string<date-time>

When the product was created.

Example:

"2026-10-02T14:03:11.000Z"

updatedAt
string<date-time>

When the product was last changed.

Example:

"2026-10-05T09:30:00.000Z"