Contractors
Get Contractor Information
Retrieve key information about a single 1099 contractor by contractorID.
GET
/
contractors
Get Contractor Information
curl --request GET \
--url https://api.zeal.com/contractors \
--header 'Authorization: <api-key>'import requests
url = "https://api.zeal.com/contractors"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.zeal.com/contractors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/contractors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/contractors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zeal.com/contractors")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/contractors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"contractorID": "1234567890",
"companyID": "1b5n28nrideucd24",
"onboarded": true,
"type": "partnership",
"first_name": "erlich",
"middle_name": "null",
"last_name": "bachman",
"email": "erlichbachman2@zeal.com",
"working_state": "MA",
"ssn": "123456789",
"ein": "null",
"business_name": "null",
"address": "320 Pancake Hollow Road",
"city": "Highland",
"state": "NY",
"zip": "12528",
"employment_status": "live",
"external_id": "1234",
"paycard_requested": false,
"paycard_enabled": false,
"kyc_status": "approved",
"ssn_verification_status": "approved"
}
}{
"success": false,
"errors": [
{
"message": "Contractor ID is not formatted correctly",
"code": 13
}
]
}This request uses the
contractorID attribute to return key information about the contractor, contained within the Contractor Object. This is the same underlying route as Get Contractors, which lists/filters instead of looking up a single contractor - the API doesn’t distinguish these with separate routes, so each page documents the query parameters for its own intended usage.
This applies to 1099 contractors. For W-2 employees, use the Get Employee Information request instead.
Returns
Returns response status and the Contractor Object for the requested contractor.| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | object | Contractor Object for the requested contractor |
| errors | array | Contains a list of error objects which consists of: message (error message) and code (error code, see Error codes) |
Authorizations
Query Parameters
Company ID of employer
ID of Contractor
Filter by Contractor onboarded status
Filter by Contractor employment status
Filter by Contractor type
Available options:
business, individual Filter by Contractor email
Filter by Contractor external ID
⌘I
Get Contractor Information
curl --request GET \
--url https://api.zeal.com/contractors \
--header 'Authorization: <api-key>'import requests
url = "https://api.zeal.com/contractors"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.zeal.com/contractors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/contractors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/contractors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zeal.com/contractors")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/contractors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"contractorID": "1234567890",
"companyID": "1b5n28nrideucd24",
"onboarded": true,
"type": "partnership",
"first_name": "erlich",
"middle_name": "null",
"last_name": "bachman",
"email": "erlichbachman2@zeal.com",
"working_state": "MA",
"ssn": "123456789",
"ein": "null",
"business_name": "null",
"address": "320 Pancake Hollow Road",
"city": "Highland",
"state": "NY",
"zip": "12528",
"employment_status": "live",
"external_id": "1234",
"paycard_requested": false,
"paycard_enabled": false,
"kyc_status": "approved",
"ssn_verification_status": "approved"
}
}{
"success": false,
"errors": [
{
"message": "Contractor ID is not formatted correctly",
"code": 13
}
]
}