List Companies

get

https://api.pax8.com/v1/companies

Returns a paginated list of all your companies filtered by optional parameters

Query Params

page

number

Defaults to 0

The page number to request for in the companies list

size

number

1 to 200

Defaults to 10

Return this number of company records per page

sort

string

enum

Return companies sorted by this field and direction. Formatted as fieldName,direction - ex. sort=name,desc

Allowed:

city

string

Return only companies matching this city value

country

string

Return only companies matching this country value

stateOrProvince

string

Return only companies matching this stateOrProvince value

postalCode

string

Return only companies matching this postalCode value

selfServiceAllowed

boolean

Return only companies matching this selfServiceAllowed value

billOnBehalfOfEnabled

boolean

Return only companies matching this billOnBehalfOfEnabled value

orderApprovalRequired

boolean

Return only companies matching this orderApprovalRequired value

status

string

enum

Return only companies matching this status value

Allowed:

Response

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation