Use this skill when working with Pax8 companies (MSP clients) - searching, retrieving, and managing client records in the Pax8 marketplace. Covers company fields, contact management, billing settings, and cross-referencing with subscriptions and orders.
Companies in Pax8 represent the MSP's client organizations. Each company is associated with subscriptions, orders, invoices, and contacts. When an MSP provisions cloud software through Pax8, it is always tied to a specific company record. Companies are the foundational entity for all marketplace operations -- products are ordered for companies, subscriptions belong to companies, and invoices are generated per company.
| Tool | Description | Key Parameters |
|---|---|---|
pax8-list-companies | List and search companies | page, size, sort (name/city/country/stateOrProvince/postalCode), order (asc/desc), company_name, status (active/inactive/deleted) |
pax8-get-company-by-uuid | Get a single company by ID | uuid (required) |
Call pax8-list-companies with optional parameters:
company_name to a company name (or partial name)status to active, inactive, or deletedsort to a field name (e.g., name) and order to asc or descpage (0-based) and size (up to 200)Example: Find all active companies sorted by name:
pax8-list-companies with status=active, sort=name, order=asc, size=200Example: Search for a company by name:
pax8-list-companies with company_name=AcmeCall pax8-get-company-by-uuid with the uuid parameter set to the company's UUID.
Example:
pax8-get-company-by-uuid with uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890Companies in Pax8 follow a straightforward lifecycle:
| Stage | Description | Typical Actions |
|---|---|---|
| Creation | New client added to Pax8 | Set name, address, billing preferences |
| Active | Client with active subscriptions | Order products, manage licenses |
| Inactive | No active subscriptions | Review for reactivation or cleanup |
In Pax8's model:
All company operations are scoped to your partner account.
Companies have billing-related settings that control how Pax8 invoices are handled:
| Setting | Description |
|---|---|
billOnBehalfOfEnabled | Whether the MSP bills the client directly through Pax8 |
selfServiceAllowed | Whether the client can self-manage subscriptions |
orderApprovalRequired | Whether orders require MSP approval before provisioning |
| Field | Type | Required | Description |
|---|---|---|---|
id | UUID | System | Auto-generated unique identifier |
name | string | Yes | Company name |
phone | string | No | Phone number |
website | string | No | Company website URL |
status | string | System | Company status |
externalId | string | No | External reference ID (for PSA integration) |
billOnBehalfOfEnabled | boolean | No | Bill-on-behalf-of setting |
selfServiceAllowed | boolean | No | Self-service access |
orderApprovalRequired | boolean | No | Require order approval |
createdDate | datetime | System | Creation timestamp |
| Field | Type | Required | Description |
|---|---|---|---|
address.street | string | No | Street address |
address.city | string | No | City |
address.stateOrProvince | string | No | State or province |
address.postalCode | string | No | Postal/ZIP code |
address.country | string | No | Country code (e.g., "US") |
Contacts are managed as a sub-resource of companies:
| Field | Type | Required | Description |
|---|---|---|---|
id | UUID | System | Contact unique identifier |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
email | string | Yes | Email address |
phone | string | No | Phone number |
types | array | No | Contact types (e.g., "Admin", "Billing", "Technical") |
pax8-list-companies with company_name set to the search termcontent arrayid (UUID) for use in other toolspax8-get-company-by-uuid with the company's uuidpax8-list-companies to check if the company already existspax8-list-products to find products, then order through the Pax8 portalpax8-list-subscriptions with the companyId to confirm provisioningUse the externalId field to match Pax8 companies with PSA records:
pax8-list-companies to get all companiesexternalId to your PSA system's company IDsexternalId as needing PSA linkagepax8-list-companies with size=200 to get all companies (paginate if needed)pax8-list-subscriptions with companyId and status=Active to get active subscription countSingle Company:
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Acme Corporation",
"address": {
"street": "123 Main St",
"city": "Springfield",
"stateOrProvince": "IL",
"postalCode": "62704",
"country": "US"
},
"phone": "555-123-4567",
"website": "https://www.acme.com",
"status": "Active",
"externalId": "PSA-12345",
"billOnBehalfOfEnabled": false,
"selfServiceAllowed": false,
"orderApprovalRequired": false,
"createdDate": "2024-01-15T10:30:00.000Z"
}
| Error | Cause | Resolution |
|---|---|---|
| Company not found | Invalid UUID | Verify the company UUID with pax8-list-companies |
| Invalid status filter | Wrong status value | Use active, inactive, or deleted |
| No results | Company name mismatch | Try a shorter or different search term |
externalIdorderApprovalRequired for new clients until trust is established