List deals

Potential sales moving through a location’s pipeline — the cards on the kanban board. `value` is cents. Archived deals are excluded unless you ask for them.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

deals:read

Query Parameters

Name	Type	Required	Description
`locationId`	string	Required	Whose board to read.
`limit`	number	Optional	Maximum number of items to return (1-100).Default: `20`
`offset`	number	Optional	Number of items to skip before starting to collect the result set.Default: `0`
`sortBy`	string	Optional	Field to sort by. Allowed values vary by endpoint.Default: `createdAt`
`sortOrder`	string asc desc	Optional	Sort direction.Default: `desc`
`search`	string	Optional	Free-text search across the resource’s primary fields.
`createdAfter`	string	Optional	ISO 8601 timestamp — only return items created after this time.
`createdBefore`	string	Optional	ISO 8601 timestamp — only return items created before this time.
`updatedAfter`	string	Optional	ISO 8601 timestamp — only return items updated after this time.
`status`	string OPEN WON LOST	Optional	Filter by outcome.
`stageId`	string	Optional	One column of the board.
`ownerId`	string	Optional	One rep’s deals.
`accountId`	string	Optional	Deals against one customer.
`includeArchived`	boolean	Optional	Set `true` to include archived deals.

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/deals" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Deals retrieved successfully!",
  "content": {
    "deals": [
      {
        "id": "del_8830",
        "referenceId": 214,
        "locationId": "loc_abc123",
        "pipelineId": "pip_01",
        "stageId": "stg_02",
        "accountId": "acc_7712",
        "ownerId": "emp_44f1",
        "title": "Northwind — annual contract",
        "value": 4800000,
        "currency": "USD",
        "status": "OPEN",
        "probability": 60,
        "expectedCloseDate": "2026-10-15T00:00:00.000Z",
        "sortOrder": 0,
        "wonLostReason": null,
        "closedAt": null,
        "stageMovedAt": "2026-08-25T10:00:00.000Z",
        "createdAt": "2026-08-10T09:00:00.000Z",
        "updatedAt": "2026-08-25T10:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

xRM → Pipeline

/xrm/pipeline