List price books
Operation ID: priceBooks
Group: Accounting › Price Books
Open in the interactive reference
GET /accounting/price-books
Read-only: Reads and returns; changes nothing.
Lists price books. To match on name or price book number, use POST accounting/price-books/search.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | string · v1 | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1. |
Query surface
id— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeactive— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenisStandard— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweendataSource— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likecreatedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenlastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between- Orderable: id, priceBookName, isStandard, active, dataSource, createdDate, lastModifiedDate
- Selectable: id, priceBookName, priceBookNumber, description, active, isStandard, dataSource, createdDate, lastModifiedDate
page[size]— Page sizepage[cursor]— Opaque continuation cursor
Response
200 Success
Under data, an array of priceBooksRow:
| Field | Type | Required | Filter | Sort | Description |
|---|---|---|---|---|---|
id |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The unique identifier for the price book. |
priceBookName |
string | no | no | yes | The display name of the price book, unique within the tenant and compared case-insensitively. |
priceBookNumber |
string | null | no | no | no | The price book number, for example 'PB-000123'. Absent until a number range assigns one. |
description |
string | null | no | no | no | A free-form description of the price book. Absent when none is set. |
active |
boolean | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | Whether the price book is active and usable in transactions. |
isStandard |
boolean | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | Whether this is the standard (default) price book. Only one price book is the standard at a time. It cannot be set through this API. |
dataSource |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The source system that provided the price book data. Absent when none is set. |
createdDate |
date-time | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date and time the price book was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
lastModifiedDate |
date-time | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date and time the price book record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priceBookName": "<priceBookName>",
"priceBookNumber": "<priceBookNumber>",
"description": "<description>",
"active": true,
"isStandard": true,
"dataSource": "<dataSource>",
"createdDate": "2026-01-15T09:30:00.000Z",
"lastModifiedDate": "2026-01-15T09:30:00.000Z"
}
],
"pagination": {
"hasMore": true,
"nextCursor": "<nextCursor>"
}
}
Statuses
400— Invalid request or business failure401— The request carries no valid access token.403— Not authorized404— Not found429— Too many requests from this client address. The response has no body and noRetry-Afterheader.500— Internal server error