---
title: "List Companies"
method: GET
path: "/companies"
tags: ["Companies"]
---

# List Companies

`GET /companies`

## Request

- Base URL: `https://api.pax8.com/v1`
- URL: `https://api.pax8.com/v1/companies`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://token-manager.pax8.com/oauth/token`

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

## Query parameters

- `page` number
- `size` number
- `sort` 'name' | 'city' | 'country' | 'stateOrProvince' | 'postalCode'
- `city` string
- `country` string
- `stateOrProvince` string
- `postalCode` string
- `selfServiceAllowed` boolean
- `billOnBehalfOfEnabled` boolean
- `orderApprovalRequired` boolean
- `status` 'Active' | 'Inactive' | 'Deleted'

## Response `200`

Successful operation

- object
  - `content` Company[]
    - `id` string, uuid: The unique id of the company
    - `name` string, required: The company name
    - `address` Address, required
      - `street` string: The primary street information
      - `street2` string: The secondary street information
      - `city` string: The city
      - `stateOrProvince` string: The state or province
      - `postalCode` string: The postal code
      - `country` string: The ISO 3166-1 alpha-2 code for the country
    - `phone` string, required: The primary phone number of the company
    - `website` string, required: The full URL of the company website
    - `externalId` string: An external ID that can be assigned to the company for reference
    - `billOnBehalfOfEnabled` boolean, required: Value is ```true``` if Pax8 handles billing transactions, value is ```false``` if partner handles billing transactions
    - `selfServiceAllowed` boolean, required: Value is ```true``` if self-service privileges are available to the company, otherwise value is ```false```
    - `orderApprovalRequired` boolean, required: Value is ```true``` if the company's self-service orders require approval, otherwise value is ```false```
    - `status` 'Active' | 'Inactive' | 'Deleted': Company Status: * `Active` - The company is active * `Inactive` - The company is inactive due to missing contacts * `Deleted` - The company has been deleted
    - `updatedDate` string, date-time: The date and time the company was last updated
    - `contacts` Contact[]: Optional array of contacts to create with the company. Including contacts during company creation will set the company status to "Active" immediately.
      - `id` string, uuid: The id
      - `firstName` string, required: The first name
      - `lastName` string, required: The last name
      - `email` string, email, required: The email
      - `phone` string, phone, required: The phone number
      - `createdDate` string: The created date
      - `types` ContactType[]
        - `type` 'Admin' | 'Billing' | 'Technical': A company must have a primary contact for each contact type. A single contact can be marked as a primary contact for all types Contact Type: * `Admin` - Administrative contact * `Billing` - Billing contact * `Technical` - Technical contact
        - `primary` boolean: Is this contact the primary contact for this Contact Type
  - `page` Page
    - `size` number: The size of the page
    - `totalElements` unknown
    - `totalPages` unknown
    - `number` unknown

---

[API](https://skmtc.dev/pax8/apis/partner-endpoints.md) - [All operations](https://skmtc.dev/pax8/apis/partner-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/pax8/apis/partner-endpoints/revisions/f90cec5b4720?raw)