Skip to main content
GET
List managed companies

Authorizations

Authorization
string
header
required

Partner API Bearer key: Authorization: Bearer <key>. Keys are created only through authorized portal or staff flows.

Query Parameters

customer_number
string

Exact paywise customer number of the managed company.

external_reference
string

Exact match on the partner-supplied external_reference.

limit
integer
default:10

Number of results to return (maximum 100).

Required range: 1 <= x <= 100
offset
integer
default:0

Zero-based result offset.

Required range: x >= 0
ordering
string

Order by company name (the default), or -name for descending order. updated_since uses its synchronization order instead.

Case-insensitive search in company names. Multiple terms must all match; quote a phrase to keep it together.

updated_since
string<date-time>

Return rows changed at or after this timezone-aware RFC 3339 timestamp. Results are ordered by updated_at and id.

Response

count
integer
required

Total number of matching resources.

Example:

123

results
object[]
required

Resources returned for the requested page.

next
string<uri> | null

URL for the next page, or null when this is the last page.

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null

URL for the previous page, or null when this is the first page.

Example:

"http://api.example.org/accounts/?offset=200&limit=100"