Get Contractor Pro for Company

{
  "companyId": "companyId",
  "totalActiveProContractors": 1,
  "proContractors": [
    {
      "employeeUserId": "employeeUserId",
      "companyId": "companyId",
      "isActive": true,
      "employeeName": "employeeName",
      "createdAt": "createdAt",
      "createdByUserId": "createdByUserId",
      "lastBilledDate": "lastBilledDate",
      "pastCancellations": [
        {
          "cancelledAt": "2024-01-15T09:30:00Z",
          "cancelledByUserId": "cancelledByUserId",
          "reason": "reason"
        },
        {
          "cancelledAt": "2024-01-15T09:30:00Z",
          "cancelledByUserId": "cancelledByUserId",
          "reason": "reason"
        }
      ]
    },
    {
      "employeeUserId": "employeeUserId",
      "companyId": "companyId",
      "isActive": true,
      "employeeName": "employeeName",
      "createdAt": "createdAt",
      "createdByUserId": "createdByUserId",
      "lastBilledDate": "lastBilledDate",
      "pastCancellations": [
        {
          "cancelledAt": "2024-01-15T09:30:00Z",
          "cancelledByUserId": "cancelledByUserId",
          "reason": "reason"
        },
        {
          "cancelledAt": "2024-01-15T09:30:00Z",
          "cancelledByUserId": "cancelledByUserId",
          "reason": "reason"
        }
      ]
    }
  ]
}

Contractors at the company who have Contractor Pro insurance. Active records only, unless you pass includeInactive.

Authentication

X-Thera-API-Keystring

API Key authentication via header

Path parameters

companyIdstringRequired

Query parameters

includeInactivebooleanOptional

If true, includes inactive/cancelled Contractor Pro records. Defaults to false.

Response

This endpoint returns an object.

companyIdstring

totalActiveProContractorsinteger

proContractorslist of objects