# Get product

Read a product by ID. Returns item: null when no visible record matches.

POST https://api.brigg.app/v1/operations/customers.GetProduct

## Access & visibility

Allow `customers.GetProduct` on your API key. Resource read permissions: `core:Product`.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | ID of a visible `core:Product` record. Find it with [customers.ListProducts](https://developer.brigg.app/reference/customers/ListProducts). Use the record's top-level `id`, not a business field or account ID. |

## Response

Returns **200 OK** with a JSON body.

`item: null` means there is no matching record visible to this caller. It does not reveal whether an inaccessible record exists.

Record metadata sits outside `data`. Timestamps `created_at` and `updated_at` are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `item` | [ProductRecord](#productrecord-response-item) or null | Yes | null when no such record |

### ProductRecord · response.item

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Stable core:Product record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited. |
| `created_at` | number | Yes | Time the record was created, in Unix milliseconds. |
| `updated_at` | number | Yes | Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads. |
| `created_by` | string or null | Yes | Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID. |
| `private` | boolean | Yes | True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules. |
| `data` | [Product](#product-response-item-data) | Yes | The record's fields. |

### Product · response.item.data

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Product or service name shown on a deal or commercial agreement. |
| `description` | string | No | Description of the product or service sold. |
| `sku` | string | No | Your stock-keeping code for this product or service. |
| `unit` | string | No | Unit billed, such as hour, item or session. |
| `unit_price_ore` | integer | No | Price for one unit in Norwegian øre. 100000 means NOK 1,000. The product catalogue is NOK-only. |
| `revenue_type` | string | No | Whether this amount is charged once or repeats monthly, quarterly or annually. Allowed: `"one_time"`, `"monthly"`, `"quarterly"`, `"annual"`. |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

- [List products](https://developer.brigg.app/reference/customers/ListProducts)
- [Create product](https://developer.brigg.app/reference/customers/CreateProduct)
- [Upsert product](https://developer.brigg.app/reference/customers/UpsertProduct)
- [Update product](https://developer.brigg.app/reference/customers/UpdateProduct)
- [Delete product](https://developer.brigg.app/reference/customers/DeleteProduct)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/customers.GetProduct' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_product_example"
}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/customers.GetProduct", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_product_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_product_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GetProduct",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "item": {
    "id": "e_product_example",
    "created_at": 1794301200000,
    "updated_at": 1794301200000,
    "created_by": "a_example",
    "private": false,
    "data": {
      "name": "Onboarding workshop",
      "description": "A half-day workshop for the project team.",
      "sku": "WORKSHOP-01",
      "unit": "session",
      "unit_price_ore": 100000,
      "revenue_type": "one_time"
    }
  }
}
```

### No visible record

A missing or inaccessible record returns item: null. Do not treat this as proof that a record exists for another member.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/customers.GetProduct' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_product_example"
}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/customers.GetProduct", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_product_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_product_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GetProduct",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "item": null
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:Product` record. Find it with [customers.ListProducts](https://developer.brigg.app/reference/customers/ListProducts). Use the record's top-level `id`, not a business field or account ID."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_product_example"
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "item": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:Product record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
        },
        "created_at": {
          "type": "number",
          "description": "Time the record was created, in Unix milliseconds."
        },
        "updated_at": {
          "type": "number",
          "description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
        },
        "created_by": {
          "type": [
            "string",
            "null"
          ],
          "description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
        },
        "private": {
          "type": "boolean",
          "description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
        },
        "data": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Product or service name shown on a deal or commercial agreement."
            },
            "description": {
              "type": "string",
              "description": "Description of the product or service sold."
            },
            "sku": {
              "type": "string",
              "description": "Your stock-keeping code for this product or service."
            },
            "unit": {
              "type": "string",
              "description": "Unit billed, such as hour, item or session."
            },
            "unit_price_ore": {
              "type": "integer",
              "description": "Price for one unit in Norwegian øre. 100000 means NOK 1,000. The product catalogue is NOK-only."
            },
            "revenue_type": {
              "type": "string",
              "enum": [
                "one_time",
                "monthly",
                "quarterly",
                "annual"
              ],
              "description": "Whether this amount is charged once or repeats monthly, quarterly or annually."
            }
          },
          "required": [
            "name"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "Product"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "null when no such record",
      "title": "ProductRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_product_example",
        "created_at": 1794301200000,
        "updated_at": 1794301200000,
        "created_by": "a_example",
        "private": false,
        "data": {
          "name": "Onboarding workshop",
          "description": "A half-day workshop for the project team.",
          "sku": "WORKSHOP-01",
          "unit": "session",
          "unit_price_ore": 100000,
          "revenue_type": "one_time"
        }
      }
    }
  ]
}
```