List contacts
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/contacts \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://my.jobin.cloud/api/openapi/v1/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/contacts"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/contacts' -Method GET -Headers $headers{
"items": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"workEmail": "<string>",
"privateEmail": "<string>",
"otherEmails": [
"<string>"
],
"workPhone": "<string>",
"privatePhone": "<string>",
"otherPhones": [
"<string>"
],
"workMobilePhone": "<string>",
"privateMobilePhone": "<string>",
"otherMobilePhones": [
"<string>"
],
"socialUrls": [
"<string>"
],
"currentTitle": "<string>",
"currentCompany": "<string>",
"currentCompanyFrom": "2023-11-07T05:31:56Z",
"currentCompanyTo": "2023-11-07T05:31:56Z",
"currentCompanyTenureYears": 123,
"currentCompanyUrl": "<string>",
"currentCompanySocialUrl": "<string>",
"location": {
"fullAddress": "<string>",
"address": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"region": "<string>",
"country": "<string>",
"countryCode": "<string>",
"postalCode": "<string>"
},
"industry": "<string>",
"seniority": "<string>",
"managementLevel": "<string>",
"previousTitle": "<string>",
"previousCompany": "<string>",
"previousCompanySocialUrl": "<string>",
"headline": "<string>",
"summary": "<string>",
"openProfile": true,
"openToWork": true,
"connectionLevels": [
{
"jobinUser": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"connectionLevel": "1st"
}
],
"currentCampaign": {
"campaignId": "<string>",
"stagePositionCode": "<string>"
},
"tags": [
{
"_id": "<string>",
"value": "<string>",
"iconName": "<string>",
"color": "<string>"
}
],
"skills": [
{
"value": "<string>",
"skillType": "<string>",
"level": 123,
"topSkill": true
}
],
"education": [
{
"school": "<string>",
"schoolSocialUrl": "<string>",
"degreeLevel": "<string>",
"degrees": [
"<string>"
],
"fieldOfStudy": "<string>",
"majors": [
"<string>"
],
"minors": [
"<string>"
],
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"isCurrent": true
}
}
],
"experiences": [
{
"title": "<string>",
"company": "<string>",
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"isCurrent": true,
"location": {
"fullAddress": "<string>",
"address": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"region": "<string>",
"country": "<string>",
"countryCode": "<string>",
"postalCode": "<string>"
},
"employmentType": "<string>",
"description": "<string>"
}
],
"languages": [
{
"value": "<string>",
"level": 123,
"note": "<string>"
}
],
"volunteering": [
{
"roleTitle": "<string>",
"organization": {
"name": "<string>",
"socialUrl": "<string>",
"companyWebsite": "<string>",
"employeeCountRange": "<string>"
},
"cause": "<string>",
"description": "<string>",
"location": {
"fullAddress": "<string>",
"address": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"region": "<string>",
"country": "<string>",
"countryCode": "<string>",
"postalCode": "<string>"
},
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"isCurrent": true
}
}
],
"accomplishments": [
{
"value": "<string>",
"type": "<string>",
"issuer": "<string>",
"description": "<string>",
"date": "2023-11-07T05:31:56Z",
"organization": {
"name": "<string>",
"socialUrl": "<string>",
"companyWebsite": "<string>",
"employeeCountRange": "<string>"
}
}
],
"customFieldList": [
{
"_id": "<string>",
"fieldName": "<string>",
"value": "<string>"
}
],
"source": "<string>",
"sourceType": "<string>",
"unsubscribed": true
}
],
"page": 123,
"limit": 123,
"nextCursor": "<string>",
"total": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}Contacts
List contacts
Find Jobin contacts by profile, location, tags, campaign, or current-company tenure.
GET
/
contacts
List contacts
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/contacts \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://my.jobin.cloud/api/openapi/v1/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/contacts"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/contacts' -Method GET -Headers $headers{
"items": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"workEmail": "<string>",
"privateEmail": "<string>",
"otherEmails": [
"<string>"
],
"workPhone": "<string>",
"privatePhone": "<string>",
"otherPhones": [
"<string>"
],
"workMobilePhone": "<string>",
"privateMobilePhone": "<string>",
"otherMobilePhones": [
"<string>"
],
"socialUrls": [
"<string>"
],
"currentTitle": "<string>",
"currentCompany": "<string>",
"currentCompanyFrom": "2023-11-07T05:31:56Z",
"currentCompanyTo": "2023-11-07T05:31:56Z",
"currentCompanyTenureYears": 123,
"currentCompanyUrl": "<string>",
"currentCompanySocialUrl": "<string>",
"location": {
"fullAddress": "<string>",
"address": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"region": "<string>",
"country": "<string>",
"countryCode": "<string>",
"postalCode": "<string>"
},
"industry": "<string>",
"seniority": "<string>",
"managementLevel": "<string>",
"previousTitle": "<string>",
"previousCompany": "<string>",
"previousCompanySocialUrl": "<string>",
"headline": "<string>",
"summary": "<string>",
"openProfile": true,
"openToWork": true,
"connectionLevels": [
{
"jobinUser": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"connectionLevel": "1st"
}
],
"currentCampaign": {
"campaignId": "<string>",
"stagePositionCode": "<string>"
},
"tags": [
{
"_id": "<string>",
"value": "<string>",
"iconName": "<string>",
"color": "<string>"
}
],
"skills": [
{
"value": "<string>",
"skillType": "<string>",
"level": 123,
"topSkill": true
}
],
"education": [
{
"school": "<string>",
"schoolSocialUrl": "<string>",
"degreeLevel": "<string>",
"degrees": [
"<string>"
],
"fieldOfStudy": "<string>",
"majors": [
"<string>"
],
"minors": [
"<string>"
],
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"isCurrent": true
}
}
],
"experiences": [
{
"title": "<string>",
"company": "<string>",
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"isCurrent": true,
"location": {
"fullAddress": "<string>",
"address": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"region": "<string>",
"country": "<string>",
"countryCode": "<string>",
"postalCode": "<string>"
},
"employmentType": "<string>",
"description": "<string>"
}
],
"languages": [
{
"value": "<string>",
"level": 123,
"note": "<string>"
}
],
"volunteering": [
{
"roleTitle": "<string>",
"organization": {
"name": "<string>",
"socialUrl": "<string>",
"companyWebsite": "<string>",
"employeeCountRange": "<string>"
},
"cause": "<string>",
"description": "<string>",
"location": {
"fullAddress": "<string>",
"address": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"region": "<string>",
"country": "<string>",
"countryCode": "<string>",
"postalCode": "<string>"
},
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"isCurrent": true
}
}
],
"accomplishments": [
{
"value": "<string>",
"type": "<string>",
"issuer": "<string>",
"description": "<string>",
"date": "2023-11-07T05:31:56Z",
"organization": {
"name": "<string>",
"socialUrl": "<string>",
"companyWebsite": "<string>",
"employeeCountRange": "<string>"
}
}
],
"customFieldList": [
{
"_id": "<string>",
"fieldName": "<string>",
"value": "<string>"
}
],
"source": "<string>",
"sourceType": "<string>",
"unsubscribed": true
}
],
"page": 123,
"limit": 123,
"nextCursor": "<string>",
"total": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}Find a contact before enrichment or campaign assignment. Combine the query parameters below to narrow your results.
Location filters use the contact’s recorded profile location. Search by country name with
country,
a case-insensitive two-letter ISO code with countryCode, or a state, province, county, or region with region.
Country codes map to country names, so contacts recorded without a country code remain searchable.
When both are supplied, country takes precedence over countryCode.
Use email or a complete socialUrl to check whether a contact already exists.
Email matching ignores case and surrounding whitespace. Supported profile URLs use the same
canonical form as contact imports, ignoring tracking parameters and trailing slashes.
Use firstName and lastName for name searches, and minYearsInCurrentRole and
maxYearsInCurrentRole for tenure at the current company. Search results can briefly lag contact updates.
Continue through results
Usepage for the first 100 pages. Continue larger result sets by passing the returned
nextCursor as cursor on the next request.
Set includeTotal=true when you need a matching count. An empty result then returns
total: 0; the default response returns total: null.
Rate limit: 120 requests/minute per endpoint and workgroup; 60 when requesting totals. Details.Authorizations
Query Parameters
Search contacts by work, private, mobile, or other phone number fields. The endpoint matches exact stored values, normalized E.164 variants when derivable, and digit-only partials. Pass the most specific number available; the value must contain at least 6 digits.
Required string length:
6 - 64Response
Paged contacts
