List Companies
Returns a paginated list of all your companies filtered by optional parameters
Request
- Base URLhttps://api.pax8.com/v1
- URLhttps://api.pax8.com/v1/companies
- AuthOAuth 2Client credentialsToken URL: https://token-manager.pax8.com/oauth/token
Query parameters
The page number to request for in the companies list
Return this number of company records per page
Return companies sorted by this field and direction. Formatted as fieldName,direction - ex. sort=name,desc
Return only companies matching this city value
Return only companies matching this country value
Return only companies matching this stateOrProvince value
Return only companies matching this postalCode value
Return only companies matching this selfServiceAllowed value
Return only companies matching this billOnBehalfOfEnabled value
Return only companies matching this orderApprovalRequired value
Return only companies matching this status value
Response
Successful operation
Example response
{
"content": [
{
"name": "Pax8",
"address": {
"street": "5500 S Quebec St",
"street2": "Ste. 350",
"city": "Greenwood Village",
"stateOrProvince": "CO",
"postalCode": "80111",
"country": "US"
},
"phone": "555-555-5555",
"website": "https://www.pax8.com/",
"contacts": [
{
"id": "18d6329e-93f9-46a5-9df7-37e4c29d2840",
"firstName": "John",
"lastName": "Doe",
"email": "john@doe.com",
"phone": "555-555-5555",
"createdDate": "2020-05-12"
}
]
}
],
"page": {
"size": 50,
"totalElements": 237,
"totalPages": 5,
"number": 1
}
}Changes
No recorded changes to this operation across all 1 revision of this API.