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"
}
Returns a paginated list of employees for a specific contractor.
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"
}
Filter by the specified contractor ID.
Cursor for pagination
Page number for offset-based pagination (only used if cursor is not provided)
x >= 1
Number of items per page
1 <= x <= 100
A list of employees associated with the contractor.
Schema for paginated employees list response using offset-based pagination.
Was this page helpful?