To get everything about a business in one call, add ?expand=true when you read it. To find a business by your external ID, list businesses with ?externalId=.

These parameters work on the Priority Commerce Engine (PCE) onboarding API:

Parameter	Use it on	What it does
`expand`	Get a business	`true` returns the full record of each owner, signatory, bank account, location and document.
`externalId`	List businesses	Returns only the business with your external ID.
`sort`	List calls	Sets the order: `createdAt`, `-createdAt`, `updatedAt` or `-updatedAt`. A leading `-` puts newest first. Default `-createdAt`.
`limit`	List calls	Sets the page size. See Pagination.
`offset`	List calls	Skips this many records before the page, so you can step through a list. See Pagination.

Get a business with full details

Without expand, a read returns the business, its addresses and its services. Other parts, like owners, come back as links: an id and a uri you can call.

curl "https://sandbox-api.prioritycommerce.com/v1/businesses/bus_8f3a2c" \
  -H "x-api-key: <your-key>"

The response is the business bus_8f3a2c, with each linked part as an id and a uri:

{
  "id": "bus_8f3a2c",
  "externalId": "example-online-goods-001",
  "legalName": "Example Online Goods LLC",
  "owners": [
    {
      "id": "own_4b7d19",
      "uri": "/v1/businesses/bus_8f3a2c/owners/own_4b7d19",
      "individual": {
        "id": "ind_2c9e51",
        "uri": "/v1/individuals/ind_2c9e51"
      }
    }
  ]
}

Add ?expand=true and each linked owner, signatory, bank account, location and document returns its full record in place of the link:

curl "https://sandbox-api.prioritycommerce.com/v1/businesses/bus_8f3a2c?expand=true" \
  -H "x-api-key: <your-key>"

Find a business by your external ID

curl "https://sandbox-api.prioritycommerce.com/v1/businesses?externalId=example-online-goods-001" \
  -H "x-api-key: <your-key>"

The matching business comes back in data:

{
  "data": [
    {
      "id": "bus_8f3a2c",
      "externalId": "example-online-goods-001",
      "legalName": "Example Online Goods LLC"
    }
  ],
  "limit": 25,
  "offset": 0,
  "returnedCount": 1,
  "totalCount": 1,
  "hasMore": false
}

Store PCE's id anyway, and use it for every other call.

Next steps

Pagination

Page through list results.