List products — Brigg developers

Access & visibility

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

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

filtersarray of objectOptional

Conditions the row must ALL satisfy.

Item fields

fieldstringRequired

data.<field> for a field of the record, or one of its own id, created_at, updated_at, created_by, private.

Allowed: "id", "created_at", "updated_at", "created_by", "private", "data.name", "data.description", "data.sku", "data.unit", "data.unit_price_ore", "data.revenue_type".

opstringRequired

Comparison operator. Use in with an array, or omit value for is_empty and is_not_empty.

Allowed: "eq", "neq", "contains", "starts_with", "gt", "gte", "lt", "lte", "in", "has", "is_empty", "is_not_empty".

valueJSON valueOptional

The comparison value; an array for in; omitted for is_empty / is_not_empty.

sortobjectOptional

Sort order for the results. Defaults to updated_at descending, with id as a tie-breaker.

Nested fields

fieldstringRequired

data.<field> for a field of the record, or one of its own id, created_at, updated_at, created_by, private.

Allowed: "id", "created_at", "updated_at", "created_by", "private", "data.name", "data.description", "data.sku", "data.unit", "data.unit_price_ore", "data.revenue_type".

directionstringOptional

Sort direction: asc for ascending or desc for descending.

Allowed: "asc", "desc".

limitintegerOptional

Maximum number of results to return in this page. Continue with next_cursor when returned.

Default: 100. Minimum: 1.

cursorstringOptional

The next_cursor of the previous page.

Filtering and sorting

All conditions are combined with AND. Address business fields as data.<field>, and record metadata as id, created_at, updated_at, created_by or private. A field path names one field; it does not traverse nested objects.

Operator	Meaning	Value
`eq`	Equal to a scalar	String, number, boolean or null
`neq`	Not equal; missing values also match	String, number, boolean or null
`contains`	Case-insensitive text contains	String; % and _ are literal characters
`starts_with`	Case-insensitive text prefix	String
`gt`, `gte`	Greater than / at least	Number or string appropriate to the field
`lt`, `lte`	Less than / at most	Number or string appropriate to the field
`in`	Equal to any supplied scalar	Nonempty array of strings, numbers, booleans or null
`has`	Array contains a string	One string; does not match properties inside array objects
`is_empty`	Missing, null, empty string or empty array	Omit value
`is_not_empty`	Has a nonempty value	Omit value

Match the stored field's type. Numeric business timestamps take Unix milliseconds; date-only business fields take YYYY-MM-DD. The record metadata fields created_at and updated_at also accept ISO timestamps for ordered comparisons.

Sorting defaults to updated_at descending. If you supply sort.field without sort.direction, direction is desc. The record ID breaks ties; missing values sort last.

Response

Returns 200 OK with a JSON body.

An empty items array means this page contains no matching visible results. Follow next_cursor when present.

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.

itemsarray of ProductRecordRequired

Records visible under the credential's grants and the selected data scope, matching the requested filters. Pass next_cursor as cursor to continue when a next cursor is returned.

Item fields

idstringRequired

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_atnumberRequired

Time the record was created, in Unix milliseconds.

updated_atnumberRequired

Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.

created_bystring or nullRequired

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.

privatebooleanRequired

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.

dataProductRequired

The record's fields.

Product

Product or service3 fields

namestringRequired

Product or service name shown on a deal or commercial agreement.

descriptionstringOptional

Description of the product or service sold.

skustringOptional

Your stock-keeping code for this product or service.

Pricing3 fields

unitstringOptional

Unit billed, such as hour, item or session.

unit_price_oreintegerOptional

Price for one unit in Norwegian øre. 100000 means NOK 1,000. The product catalogue is NOK-only.

revenue_typestringOptional

Whether this amount is charged once or repeats monthly, quarterly or annually.

Allowed: "one_time", "monthly", "quarterly", "annual".

next_cursorstringOptional

Pass this value as cursor to continue with the same filters, sort and credential. Omitted when there are no more results.

Pagination

Pass next_cursor from the response as cursor on the next request. Keep the same filters, sort and acting identity. Stop when next_cursor is absent; do not infer completion from the number of items. The default page size is 100; limit must be a positive integer.

Pagination is a live view, not a snapshot. Changes between pages can move records across page boundaries. Upsert by record ID rather than appending blindly. For recurring synchronization, use an overlapping update window and deduplicate records. Periodically reconcile IDs to detect deletions. Resource webhooks can supplement synchronization for eligible workspace-shared records only: they do not export private or project-scoped records. Personal data still needs polling and reconciliation.

const query = {
  "limit": 10
};
let cursor;
do {
  const response = await fetch("https://api.brigg.app/v1/operations/customers.ListProducts", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ ...query, ...(cursor ? { cursor } : {}) }),
  });
  const page = await response.json();
  if (!response.ok) throw new Error(`${response.status}: ${page.message}`);
  for (const item of page.items) {
    console.log(item); // Process or upsert each result.
  }
  cursor = page.next_cursor;
} while (cursor);

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 and safe retries and limits.

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.
400	`cursor_invalid`	Restart pagination with no cursor.
400	`cursor_mismatch`	Use the cursor with the original filters, sort order and credential.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "`data.<field>` for a field of the record, or one of its own id, created_at, updated_at, created_by, private.",
            "enum": [
              "id",
              "created_at",
              "updated_at",
              "created_by",
              "private",
              "data.name",
              "data.description",
              "data.sku",
              "data.unit",
              "data.unit_price_ore",
              "data.revenue_type"
            ]
          },
          "op": {
            "type": "string",
            "enum": [
              "eq",
              "neq",
              "contains",
              "starts_with",
              "gt",
              "gte",
              "lt",
              "lte",
              "in",
              "has",
              "is_empty",
              "is_not_empty"
            ],
            "description": "Comparison operator. Use in with an array, or omit value for is_empty and is_not_empty."
          },
          "value": {
            "description": "The comparison value; an array for `in`; omitted for is_empty / is_not_empty."
          }
        },
        "required": [
          "field",
          "op"
        ],
        "additionalProperties": false
      },
      "description": "Conditions the row must ALL satisfy."
    },
    "sort": {
      "type": "object",
      "properties": {
        "field": {
          "type": "string",
          "description": "`data.<field>` for a field of the record, or one of its own id, created_at, updated_at, created_by, private.",
          "enum": [
            "id",
            "created_at",
            "updated_at",
            "created_by",
            "private",
            "data.name",
            "data.description",
            "data.sku",
            "data.unit",
            "data.unit_price_ore",
            "data.revenue_type"
          ]
        },
        "direction": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "description": "Sort direction: asc for ascending or desc for descending."
        }
      },
      "required": [
        "field"
      ],
      "additionalProperties": false,
      "description": "Sort order for the results. Defaults to updated_at descending, with id as a tie-breaker."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "default": 100,
      "description": "Maximum number of results to return in this page. Continue with next_cursor when returned."
    },
    "cursor": {
      "type": "string",
      "description": "The `next_cursor` of the previous page."
    }
  },
  "additionalProperties": false,
  "examples": [
    {
      "limit": 10
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "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,
        "title": "ProductRecord"
      },
      "description": "Records visible under the credential's grants and the selected data scope, matching the requested filters. Pass next_cursor as cursor to continue when a next cursor is returned."
    },
    "next_cursor": {
      "type": "string",
      "description": "Pass this value as cursor to continue with the same filters, sort and credential. Omitted when there are no more results."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "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"
          }
        }
      ]
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

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

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.ListProducts' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "limit": 10
}'

TypeScript

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

Python

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

payload = {
  "limit": 10
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.ListProducts",
    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

cURL

curl 'https://api.brigg.app/v1/operations/customers.ListProducts' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "limit": 10
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

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

Python

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

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

200 OK Response example

{
  "items": [
    {
      "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"
      }
    }
  ]
}

Illustrative values, not a live response.

Compare your stock-keeping unit exactly. Store the returned Brigg ID for later references.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.ListProducts' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "limit": 50,
  "filters": [
    {
      "field": "data.sku",
      "op": "eq",
      "value": "CONSULT-HOUR"
    }
  ]
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/customers.ListProducts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "limit": 50,
    "filters": [
      {
        "field": "data.sku",
        "op": "eq",
        "value": "CONSULT-HOUR"
      }
    ]
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

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

payload = {
  "limit": 50,
  "filters": [
    {
      "field": "data.sku",
      "op": "eq",
      "value": "CONSULT-HOUR"
    }
  ]
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.ListProducts",
    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

cURL

curl 'https://api.brigg.app/v1/operations/customers.ListProducts' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "limit": 50,
  "filters": [
    {
      "field": "data.sku",
      "op": "eq",
      "value": "CONSULT-HOUR"
    }
  ]
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.ListProducts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "limit": 50,
    "filters": [
      {
        "field": "data.sku",
        "op": "eq",
        "value": "CONSULT-HOUR"
      }
    ]
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

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

payload = {
  "limit": 50,
  "filters": [
    {
      "field": "data.sku",
      "op": "eq",
      "value": "CONSULT-HOUR"
    }
  ]
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.ListProducts",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "items": [
    {
      "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": "CONSULT-HOUR",
        "unit": "session",
        "unit_price_ore": 100000,
        "revenue_type": "one_time"
      }
    }
  ]
}

Illustrative values, not a live response.

6 October 2026 at 00:00 UTC. Use an overlap window and upsert by ID when synchronizing.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.ListProducts' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "filters": [
    {
      "field": "updated_at",
      "op": "gte",
      "value": 1791244800000
    }
  ],
  "sort": {
    "field": "updated_at",
    "direction": "asc"
  },
  "limit": 100
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/customers.ListProducts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "filters": [
      {
        "field": "updated_at",
        "op": "gte",
        "value": 1791244800000
      }
    ],
    "sort": {
      "field": "updated_at",
      "direction": "asc"
    },
    "limit": 100
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

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

payload = {
  "filters": [
    {
      "field": "updated_at",
      "op": "gte",
      "value": 1791244800000
    }
  ],
  "sort": {
    "field": "updated_at",
    "direction": "asc"
  },
  "limit": 100
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.ListProducts",
    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

cURL

curl 'https://api.brigg.app/v1/operations/customers.ListProducts' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "filters": [
    {
      "field": "updated_at",
      "op": "gte",
      "value": 1791244800000
    }
  ],
  "sort": {
    "field": "updated_at",
    "direction": "asc"
  },
  "limit": 100
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.ListProducts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "filters": [
      {
        "field": "updated_at",
        "op": "gte",
        "value": 1791244800000
      }
    ],
    "sort": {
      "field": "updated_at",
      "direction": "asc"
    },
    "limit": 100
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

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

payload = {
  "filters": [
    {
      "field": "updated_at",
      "op": "gte",
      "value": 1791244800000
    }
  ],
  "sort": {
    "field": "updated_at",
    "direction": "asc"
  },
  "limit": 100
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.ListProducts",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "items": [
    {
      "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"
      }
    }
  ]
}

Illustrative values, not a live response.