GET
/
contractors
/
{id}
/
employees
List Contractor Employees
curl --request GET \
  --url https://api.shovels.ai/v2/contractors/{id}/employees \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "aa145cd32c95f69b95e9233f6a957a32",
      "contractor_id": "8wKHB2ZNf",
      "name": "John Smith",
      "street_no": "123",
      "street": "Oak Avenue",
      "city": "San Francisco",
      "zip_code": "94105",
      "zip_code_ext": "1234",
      "state": "CA",
      "phone": "(415) 555-0123",
      "email": "john.smith@personal.com",
      "business_email": "j.smith@company.com",
      "linkedin_url": "https://linkedin.com/in/johnsmith",
      "homeowner": "Y",
      "gender": "M",
      "age_range": "35-44",
      "is_married": true,
      "has_children": true,
      "income_range": "$120,000 to $149,999",
      "net_worth": "$150,000 to $249,999",
      "job_title": "Senior Solar Installation Technician",
      "seniority_level": "Senior",
      "department": "Installation"
    },
    {
      "id": "73744cd32c95f69b95e9233f6a957d90",
      "contractor_id": "8wKHB2ZNf",
      "name": "Sarah Johnson",
      "street_no": "456",
      "street": "Pine Street",
      "city": "Oakland",
      "zip_code": "94611",
      "zip_code_ext": "5678",
      "state": "CA",
      "phone": "(510) 555-0456",
      "email": "sarah.j@personal.com",
      "business_email": "s.johnson@company.com",
      "linkedin_url": "https://linkedin.com/in/sarahjohnson",
      "homeowner": "N",
      "gender": "F",
      "age_range": "25-34",
      "is_married": false,
      "has_children": false,
      "income_range": "$75,000 to $100,000",
      "net_worth": "$150,000 to $249,999",
      "job_title": "Project Manager",
      "seniority_level": "Mid",
      "department": "Operations"
    }
  ],
  "size": 2,
  "next_cursor": "eyJjb250cmFjdG9yX2l",
  "pagination_type": "cursor"
}

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

Filter by the specified contractor ID.

Query Parameters

cursor
string | null

Cursor for pagination

page
integer | null

Page number for offset-based pagination (only used if cursor is not provided)

Required range: x >= 1
size
integer
default:50

Number of items per page

Required range: 1 <= x <= 100

Response

A list of employees associated with the contractor.

Schema for paginated employees list response using offset-based pagination.

items
Employees · object[]
required

The list of items returned in the response following given criteria.

page
integer
required

The page number of the response.

size
integer
required

The number of items returned in the response.

next_page
integer | null
required

The next page number of the response.

pagination_type
string
default:offset
Allowed value: "offset"