API docs by Redocly

Sense API (1.0.0)

Download OpenAPI specification:Download

Overview

Introduction

Use the Sense API to synchronize your ATS data into the Sense Platform. The RESTFUL API is used to seed the initial set of entities and keep them up-to-date over time. Synchronizing data into Sense is what powers the automation of Sense Workflows.

API Client

Our API definition uses the OpenAPI 3.0 specification. You can download the definition and create a client library using the openapi-generator project.

Authorization

Authenticate to the Sense API using OAuth2 client credentials. The Sense Team will provide you with credentials that will synchronize data to your account at your-agency-name.sensehq.com.

sense_authentication

Security Scheme Type: OAuth2
Flow type: clientCredentials
Token URL: https://partner-auth.sensehq.com/oauth2/token
Scopes:
  • N/A -

    The Sense API does not require a scope to be provided.

sense_bearer_auth

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: JWT

⚠️ Token Caching & Rate Limits

IMPORTANT: Clients must cache and reuse access tokens until they expire, as indicated by the expires_in field in the token response.

Sample Token Response

{
  "access_token": "eyJr...",
  "expires_in": 300,
  "token_type": "Bearer"
}

✅ OAuth Token Best Practices

To ensure stable, efficient, and compliant integrations with the Sense API, follow these best practices:

  • Cache the access token securely and reuse it for all requests until it expires.
  • Always respect the expires_in field returned in the token response.

    ⚠️ Do not hardcode the expiry time (e.g., 5 minutes). While the current token lifetime is 300 seconds (5 minutes), it may change in the future without notice. Your integration should dynamically honor the expires_in value provided.

  • Only request a new token when the existing one is about to expire.
  • Avoid calling the token endpoint unnecessarily — doing so may lead to rate limiting or deactivation.
  • Implement retry logic with exponential backoff in case of transient failures.
  • Monitor your integration for abnormal token request patterns.

Following these practices ensures better reliability, reduces infrastructure strain, and prevents disruptions to your access.

Helpful Resources for Token Caching

Depending on your tech stack, here are some guides and libraries to help implement OAuth token caching:

General

Node.js

Python

Java

Postman

Implement token caching early in your integration lifecycle to ensure your application is efficient and remains in good standing with Sense API rate limits.

Synchronizing Data

To synchronize data with Sense, we need the initial seed of entity data (Candidates, Placements, etc), and updates to those entities over time. To accomplish this, we recommend two processes named Sync and Change Event.

When data is sent and accepted by the Sense API, the data is enqueued to be processed by Sense's background processes. You should expect data to be visible in the Sense product 30 minutes after your API call for Change Event processes.

Sync Process

The sync is generally a long running process that iterates over your entire data set and calls the Sense API. For example, to sync a database of 1 million candidates, POST to the /candidates endpoint in batches of 500 under 256 kb after compression.

Change Event Process

To keep the initial set of data up-to-date, the Change Event process can be implemented as a hook whenever your entities change. You can call the Sense API POST /candidates when any of the fields defined in the Candidate model change. To take advantage of batching (our API supports 500 updates at a time under 256 kb after compression), your Change Event process can flush changes to the Sense API after it accumulates 500 updates, exceeds 256 kb after compression or after 5 minutes, whichever comes first.

Sync Operation

Considerations

  • Record the time the Sync Process started as the timestamp to query for changed entities, then use it in your Change Event process to get all changes since that timestamp so no updates are missed.
  • The entity data must be complete. When an entity is sent to the API, it's treated as an UPSERT operation - the old version of the entity is replaced with the new version.

Data Model Overview

Entity types

Candidate

A person seeking a job.

Placement

A job that has been filled by a Candidate.

InternalUser

An internal person at your organization.

JobOrder

A job to be filled by a Candidate.

Company

A company that is a client of your organization.

ClientContact

A contact person at a Company.

Appointment

An interview or a meeting with a Candidate or Contact.

Submission

Sending a Candidate’s info for additional review.

Certification

The credential and or certificate of Candidate, or as required by a Job.

Lead

A new prospective client or contact

 

Field types

id

Primary key of the entity. This represents the ID in your system and is not managed by Sense. All ids are treated as strings.

  • Nullable: True
  • Examples
    • Candidate Entity: { "id": "123", "first_name": "Linus", ... }

int, float, string

  • Nullable: True
  • Examples
    • 1, 1.0, "hello world"

datetime

  • Nullable: True
  • Format: ISO 8601
  • Strict Validation: If a datetime field is unable to be parsed in ISO 8601 format, the update is rejected and the API will return a 400 Bad Request.
  • Examples
    • 2020-04-01T10:30:00+0000 is 2020-04-01 at 10:30 AM UTC.
    • 2020-04-01T10:30:00-0700 is 2020-04-01 at 10:30 AM Pacific.

ref

Represents a primary key reference to another entity.

  • Nullable: True
  • Format: string
  • Examples:
    • A field named "internal_user_id" on Placement points to an InternalUser by its primary key.
      • Placement Entity: { "id": "123", "internal_user_id": "456", "status": "Active", ... }
      • Internal User Entity: { "id": "456", "first_name": "Ace" }

Sample Code

Post a Candidate Entity 
import requests

# Obtain a Bearer token using your client credentials.
auth_response = requests.post(
    "https://partner-auth.sensehq.com/oauth2/token",
    data={
        "client_id": "client_id",
        "client_secret": "client_secret",
        "grant_type": "client_credentials",
    },
)
assert auth_response.status_code == 200
print("Authenticated successfully.")

# Post a Candidate entity.
bearer_token = auth_response.json()["access_token"]
response = requests.post(
    "https://partner-api.sensehq.com/v1/candidates",
    json=[{
        "id": "123",
        "first_name": "Linus",
        "last_name": "Kerns",
        "email": "linus@sensehq.com",
        "mobile_phone": "(415) 555-1234",
        "status": "Active",
    }],
    headers={"Authorization": f"Bearer {bearer_token}"},
)
assert response.status_code == 201
print("Posted Candidate successfully.")
 
Update a Candidate Entity 
import requests

# Obtain a Bearer token using your client credentials.
auth_response = requests.post(
    "https://partner-auth.sensehq.com/oauth2/token",
    data={
        "client_id": "client_id",
        "client_secret": "client_secret",
        "grant_type": "client_credentials",
    },
)
assert auth_response.status_code == 200
print("Authenticated successfully.")

# Update a Candidate entity.
bearer_token = auth_response.json()["access_token"]
resource_id = 123
response = requests.patch(
    f"https://partner-api.sensehq.com/v1/candidates/{resource_id}",
    json={
        "status": "InActive",
    },
    headers={"Authorization": f"Bearer {bearer_token}"},
)
assert response.status_code == 201
print("Updated Candidate successfully.")
 
Fetch a Candidate Entity 
import requests

# Obtain a Bearer token using your client credentials.
auth_response = requests.post(
    "https://partner-auth.sensehq.com/oauth2/token",
    data={
        "client_id": "client_id",
        "client_secret": "client_secret",
        "grant_type": "client_credentials",
    },
)
assert auth_response.status_code == 200
print("Authenticated successfully.")

# Get a Candidate entity.
bearer_token = auth_response.json()["access_token"]
resource_id = 123

get_api_response = requests.get(f"https://partner-api.sensehq.com/v1/candidates/{resource_id}",
    headers={"Authorization": f"Bearer {bearer_token}"},)

assert get_api_response.status_code == 200
print(f"Fetched candidate successfully")

Authentication

Authenticate using client credentials to obtain a Bearer access_token.

Authenticate

Authenticate using client credentials to obtain a Bearer access_token.

Authorizations:
sense_authentication
Request Body schema: application/x-www-form-urlencoded
client_id
string
client_secret
string
grant_type
string

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "token_type": "string"
}

Appointment

An interview or a meeting with a Candidate or Contact.

Upsert Appointment

Batch upsert Appointment entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
application_id
string or null
candidate_id
string or null
client_contact_id
string or null
communication_method
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_end
string or null <date-time>
date_last_modified
string or null <date-time>
date_start
string or null <date-time>
date_task_complete
string or null <date>
date_task_due
string or null <date-time>
description
string or null
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
internal_user_id4
string or null
internal_user_id5
string or null
internal_user_id6
string or null
is_all_day
boolean or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

is_private
boolean or null
is_task
boolean or null
job_order_id
string or null
location
string or null
owner_id
string or null
placement_id
string or null
subject
string or null
task_complete
boolean or null
type
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve Appointment details

Fetch details of a single Appointment entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the Appointment whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update Appointment

Update single Appointment entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the Appointmentwhose details need to be updated.

Request Body schema: application/json
application_id
string or null
candidate_id
string or null
client_contact_id
string or null
communication_method
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_end
string or null <date-time>
date_last_modified
string or null <date-time>
date_start
string or null <date-time>
date_task_complete
string or null <date>
date_task_due
string or null <date-time>
description
string or null
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
internal_user_id4
string or null
internal_user_id5
string or null
internal_user_id6
string or null
is_all_day
boolean or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

is_private
boolean or null
is_task
boolean or null
job_order_id
string or null
location
string or null
owner_id
string or null
placement_id
string or null
subject
string or null
task_complete
boolean or null
type
string or null

Responses

Request samples

Content type
application/json
{
  • "application_id": "string",
  • "candidate_id": "string",
  • "client_contact_id": "string",
  • "communication_method": "string",
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_date1": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "custom_text_block1": "string",
  • "custom_text_block2": "string",
  • "custom_text_block3": "string",
  • "custom_text_block4": "string",
  • "custom_text_block5": "string",
  • "custom_text_block6": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_end": "2019-08-24T14:15:22Z",
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "date_start": "2019-08-24T14:15:22Z",
  • "date_task_complete": "2019-08-24",
  • "date_task_due": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "internal_user_id": "string",
  • "internal_user_id2": "string",
  • "internal_user_id3": "string",
  • "internal_user_id4": "string",
  • "internal_user_id5": "string",
  • "internal_user_id6": "string",
  • "is_all_day": true,
  • "is_archived": true,
  • "is_deleted": true,
  • "is_private": true,
  • "is_task": true,
  • "job_order_id": "string",
  • "location": "string",
  • "owner_id": "string",
  • "placement_id": "string",
  • "subject": "string",
  • "task_complete": true,
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a Appointment field

Fetch the list of possible values configured for a field on the Appointment entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a Appointment field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Candidate

A person seeking a job.

Upsert Candidate

Batch upsert Candidate entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
active
boolean or null
address1
string or null
address2
string or null
categories
Array of strings or null
city
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_boolean1
boolean or null
custom_boolean10
boolean or null
custom_boolean11
boolean or null
custom_boolean12
boolean or null
custom_boolean13
boolean or null
custom_boolean14
boolean or null
custom_boolean15
boolean or null
custom_boolean2
boolean or null
custom_boolean3
boolean or null
custom_boolean4
boolean or null
custom_boolean5
boolean or null
custom_boolean6
boolean or null
custom_boolean7
boolean or null
custom_boolean8
boolean or null
custom_boolean9
boolean or null
custom_date1
string or null <date>
custom_date10
string or null <date>
custom_date11
string or null <date>
custom_date12
string or null <date>
custom_date13
string or null <date>
custom_date14
string or null <date>
custom_date15
string or null <date>
custom_date16
string or null <date>
custom_date17
string or null <date>
custom_date18
string or null <date>
custom_date19
string or null <date>
custom_date2
string or null <date>
custom_date20
string or null <date>
custom_date21
string or null <date>
custom_date22
string or null <date>
custom_date23
string or null <date>
custom_date24
string or null <date>
custom_date25
string or null <date>
custom_date26
string or null <date>
custom_date27
string or null <date>
custom_date28
string or null <date>
custom_date29
string or null <date>
custom_date3
string or null <date>
custom_date30
string or null <date>
custom_date31
string or null <date>
custom_date32
string or null <date>
custom_date33
string or null <date>
custom_date34
string or null <date>
custom_date35
string or null <date>
custom_date36
string or null <date>
custom_date37
string or null <date>
custom_date38
string or null <date>
custom_date39
string or null <date>
custom_date4
string or null <date>
custom_date40
string or null <date>
custom_date41
string or null <date>
custom_date42
string or null <date>
custom_date43
string or null <date>
custom_date44
string or null <date>
custom_date45
string or null <date>
custom_date46
string or null <date>
custom_date47
string or null <date>
custom_date48
string or null <date>
custom_date49
string or null <date>
custom_date5
string or null <date>
custom_date50
string or null <date>
custom_date6
string or null <date>
custom_date7
string or null <date>
custom_date8
string or null <date>
custom_date9
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_last_activity
string or null <date-time>
date_last_modified
string or null <date-time>
date_of_birth
string or null <date>
email
string or null
email2
string or null
email3
string or null
ethnicity
string or null

The gender and ethnicity standard fields will be used to facilitate audits and will not be available in the front end of Sense. For more details, please review how Sense complies with the NYC Basis Audit Law: here

first_name
string or null
gender
string or null

The gender and ethnicity standard fields will be used to facilitate audits and will not be available in the front end of Sense. For more details, please review how Sense complies with the NYC Basis Audit Law: here

home_phone
string or null
id
required
string non-empty
industries
Array of strings or null
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

last_name
string or null
mobile_phone
string or null
nick_name
string or null
office
string or null
opt_out_email
boolean or null
opt_out_sms
boolean or null
phone4
string or null
phone5
string or null
preferred_contact_method
string or null
skills
Array of strings or null
source
string or null
specialties
Array of strings or null
state
string or null
status
string or null
title
string or null
work_phone
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve Candidate details

Fetch details of a single Candidate entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the Candidate whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update Candidate

Update single Candidate entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the Candidatewhose details need to be updated.

Request Body schema: application/json
active
boolean or null
address1
string or null
address2
string or null
categories
Array of strings or null
city
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_boolean1
boolean or null
custom_boolean10
boolean or null
custom_boolean11
boolean or null
custom_boolean12
boolean or null
custom_boolean13
boolean or null
custom_boolean14
boolean or null
custom_boolean15
boolean or null
custom_boolean2
boolean or null
custom_boolean3
boolean or null
custom_boolean4
boolean or null
custom_boolean5
boolean or null
custom_boolean6
boolean or null
custom_boolean7
boolean or null
custom_boolean8
boolean or null
custom_boolean9
boolean or null
custom_date1
string or null <date>
custom_date10
string or null <date>
custom_date11
string or null <date>
custom_date12
string or null <date>
custom_date13
string or null <date>
custom_date14
string or null <date>
custom_date15
string or null <date>
custom_date16
string or null <date>
custom_date17
string or null <date>
custom_date18
string or null <date>
custom_date19
string or null <date>
custom_date2
string or null <date>
custom_date20
string or null <date>
custom_date21
string or null <date>
custom_date22
string or null <date>
custom_date23
string or null <date>
custom_date24
string or null <date>
custom_date25
string or null <date>
custom_date26
string or null <date>
custom_date27
string or null <date>
custom_date28
string or null <date>
custom_date29
string or null <date>
custom_date3
string or null <date>
custom_date30
string or null <date>
custom_date31
string or null <date>
custom_date32
string or null <date>
custom_date33
string or null <date>
custom_date34
string or null <date>
custom_date35
string or null <date>
custom_date36
string or null <date>
custom_date37
string or null <date>
custom_date38
string or null <date>
custom_date39
string or null <date>
custom_date4
string or null <date>
custom_date40
string or null <date>
custom_date41
string or null <date>
custom_date42
string or null <date>
custom_date43
string or null <date>
custom_date44
string or null <date>
custom_date45
string or null <date>
custom_date46
string or null <date>
custom_date47
string or null <date>
custom_date48
string or null <date>
custom_date49
string or null <date>
custom_date5
string or null <date>
custom_date50
string or null <date>
custom_date6
string or null <date>
custom_date7
string or null <date>
custom_date8
string or null <date>
custom_date9
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_last_activity
string or null <date-time>
date_last_modified
string or null <date-time>
date_of_birth
string or null <date>
email
string or null
email2
string or null
email3
string or null
ethnicity
string or null

The gender and ethnicity standard fields will be used to facilitate audits and will not be available in the front end of Sense. For more details, please review how Sense complies with the NYC Basis Audit Law: here

first_name
string or null
gender
string or null

The gender and ethnicity standard fields will be used to facilitate audits and will not be available in the front end of Sense. For more details, please review how Sense complies with the NYC Basis Audit Law: here

home_phone
string or null
id
required
string non-empty
industries
Array of strings or null
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

last_name
string or null
mobile_phone
string or null
nick_name
string or null
office
string or null
opt_out_email
boolean or null
opt_out_sms
boolean or null
phone4
string or null
phone5
string or null
preferred_contact_method
string or null
skills
Array of strings or null
source
string or null
specialties
Array of strings or null
state
string or null
status
string or null
title
string or null
work_phone
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "address1": "string",
  • "address2": "string",
  • "categories": [
    ],
  • "city": "string",
  • "country": "string",
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_boolean1": true,
  • "custom_boolean10": true,
  • "custom_boolean11": true,
  • "custom_boolean12": true,
  • "custom_boolean13": true,
  • "custom_boolean14": true,
  • "custom_boolean15": true,
  • "custom_boolean2": true,
  • "custom_boolean3": true,
  • "custom_boolean4": true,
  • "custom_boolean5": true,
  • "custom_boolean6": true,
  • "custom_boolean7": true,
  • "custom_boolean8": true,
  • "custom_boolean9": true,
  • "custom_date1": "2019-08-24",
  • "custom_date10": "2019-08-24",
  • "custom_date11": "2019-08-24",
  • "custom_date12": "2019-08-24",
  • "custom_date13": "2019-08-24",
  • "custom_date14": "2019-08-24",
  • "custom_date15": "2019-08-24",
  • "custom_date16": "2019-08-24",
  • "custom_date17": "2019-08-24",
  • "custom_date18": "2019-08-24",
  • "custom_date19": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date20": "2019-08-24",
  • "custom_date21": "2019-08-24",
  • "custom_date22": "2019-08-24",
  • "custom_date23": "2019-08-24",
  • "custom_date24": "2019-08-24",
  • "custom_date25": "2019-08-24",
  • "custom_date26": "2019-08-24",
  • "custom_date27": "2019-08-24",
  • "custom_date28": "2019-08-24",
  • "custom_date29": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date30": "2019-08-24",
  • "custom_date31": "2019-08-24",
  • "custom_date32": "2019-08-24",
  • "custom_date33": "2019-08-24",
  • "custom_date34": "2019-08-24",
  • "custom_date35": "2019-08-24",
  • "custom_date36": "2019-08-24",
  • "custom_date37": "2019-08-24",
  • "custom_date38": "2019-08-24",
  • "custom_date39": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date40": "2019-08-24",
  • "custom_date41": "2019-08-24",
  • "custom_date42": "2019-08-24",
  • "custom_date43": "2019-08-24",
  • "custom_date44": "2019-08-24",
  • "custom_date45": "2019-08-24",
  • "custom_date46": "2019-08-24",
  • "custom_date47": "2019-08-24",
  • "custom_date48": "2019-08-24",
  • "custom_date49": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date50": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_date7": "2019-08-24",
  • "custom_date8": "2019-08-24",
  • "custom_date9": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "custom_text_block1": "string",
  • "custom_text_block2": "string",
  • "custom_text_block3": "string",
  • "custom_text_block4": "string",
  • "custom_text_block5": "string",
  • "custom_text_block6": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_last_activity": "2019-08-24T14:15:22Z",
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "date_of_birth": "2019-08-24",
  • "email": "string",
  • "email2": "string",
  • "email3": "string",
  • "ethnicity": "string",
  • "first_name": "string",
  • "gender": "string",
  • "home_phone": "string",
  • "id": "string",
  • "industries": [
    ],
  • "internal_user_id": "string",
  • "internal_user_id2": "string",
  • "internal_user_id3": "string",
  • "is_archived": true,
  • "is_deleted": true,
  • "last_name": "string",
  • "mobile_phone": "string",
  • "nick_name": "string",
  • "office": "string",
  • "opt_out_email": true,
  • "opt_out_sms": true,
  • "phone4": "string",
  • "phone5": "string",
  • "preferred_contact_method": "string",
  • "skills": [
    ],
  • "source": "string",
  • "specialties": [
    ],
  • "state": "string",
  • "status": "string",
  • "title": "string",
  • "work_phone": "string",
  • "zipcode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a Candidate field

Fetch the list of possible values configured for a field on the Candidate entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a Candidate field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Upload Candidate Resume

Upload a resume file for a specific candidate. The file must be sent as multipart/form-data. Supported formats include pdf, doc, docx, txt, rtf, odt, html, htm.

Maximum supported file upload size is 4MB.

Authorizations:
sense_bearer_auth
path Parameters
id
required
string

The unique ID of the candidate.

Request Body schema: multipart/form-data
date_created
required
string <date-time>

Date when the resume was created in the ATS.

date_updated
required
string <date-time>

Date when the resume was last updated in the ATS.

file
required
string <binary>

The resume file to upload. (Maximum file size: 4 MB)

file_extension
required
string

The format of the file (Supported values : pdf, doc, docx, txt, rtf, odt, html, htm)

file_name
string or null

The resume file name.

resume_id
required
string

The unique identifier for this resume file.

Responses

Request samples

Content type
multipart/form-data
{
  "date_created": "2026-01-20T08:00:00Z",
  "date_updated": "2026-03-15T10:30:00Z",
  "file": "<binary file content>",
  "file_extension": "pdf",
  "file_name": "john_doe_resume.pdf",
  "resume_id": "RES-78901"
}

Response samples

Content type
application/json
{
  • "message": "request 86887e46-5b72-450a-b6c4-2017a9faa566 is received",
  • "request_id": "86887e46-5b72-450a-b6c4-2017a9faa566"
}

Certification

The credential and or certificate of Candidate, or as required by a Job.

Upsert Certification

Batch upsert Certification entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
board_certification
string or null
candidate_id
string or null
comments
string or null
compact
boolean or null
copy_on_file
boolean or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_certified
string or null <date>
date_expiration
string or null <date>
date_last_modified
string or null <date-time>
id
required
string non-empty
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

issued_by
string or null
job_order_id
string or null
license_number
string or null
license_type
string or null
location
string or null
name
string or null
placement_id
string or null
results
string or null
status
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve Certification details

Fetch details of a single Certification entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the Certification whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update Certification

Update single Certification entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the Certificationwhose details need to be updated.

Request Body schema: application/json
board_certification
string or null
candidate_id
string or null
comments
string or null
compact
boolean or null
copy_on_file
boolean or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_certified
string or null <date>
date_expiration
string or null <date>
date_last_modified
string or null <date-time>
id
required
string non-empty
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

issued_by
string or null
job_order_id
string or null
license_number
string or null
license_type
string or null
location
string or null
name
string or null
placement_id
string or null
results
string or null
status
string or null

Responses

Request samples

Content type
application/json
{
  • "board_certification": "string",
  • "candidate_id": "string",
  • "comments": "string",
  • "compact": true,
  • "copy_on_file": true,
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_date1": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "custom_text_block1": "string",
  • "custom_text_block2": "string",
  • "custom_text_block3": "string",
  • "custom_text_block4": "string",
  • "custom_text_block5": "string",
  • "custom_text_block6": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_certified": "2019-08-24",
  • "date_expiration": "2019-08-24",
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "is_archived": true,
  • "is_deleted": true,
  • "issued_by": "string",
  • "job_order_id": "string",
  • "license_number": "string",
  • "license_type": "string",
  • "location": "string",
  • "name": "string",
  • "placement_id": "string",
  • "results": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a Certification field

Fetch the list of possible values configured for a field on the Certification entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a Certification field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

ClientContact

A contact person at a Company.

Upsert ClientContact

Batch upsert ClientContact entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
active
boolean or null
address1
string or null
address2
string or null
city
string or null
company_id
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date10
string or null <date>
custom_date11
string or null <date>
custom_date12
string or null <date>
custom_date13
string or null <date>
custom_date14
string or null <date>
custom_date15
string or null <date>
custom_date16
string or null <date>
custom_date17
string or null <date>
custom_date18
string or null <date>
custom_date19
string or null <date>
custom_date2
string or null <date>
custom_date20
string or null <date>
custom_date21
string or null <date>
custom_date22
string or null <date>
custom_date23
string or null <date>
custom_date24
string or null <date>
custom_date25
string or null <date>
custom_date26
string or null <date>
custom_date27
string or null <date>
custom_date28
string or null <date>
custom_date29
string or null <date>
custom_date3
string or null <date>
custom_date30
string or null <date>
custom_date31
string or null <date>
custom_date32
string or null <date>
custom_date33
string or null <date>
custom_date34
string or null <date>
custom_date35
string or null <date>
custom_date36
string or null <date>
custom_date37
string or null <date>
custom_date38
string or null <date>
custom_date39
string or null <date>
custom_date4
string or null <date>
custom_date40
string or null <date>
custom_date41
string or null <date>
custom_date42
string or null <date>
custom_date43
string or null <date>
custom_date44
string or null <date>
custom_date45
string or null <date>
custom_date46
string or null <date>
custom_date47
string or null <date>
custom_date48
string or null <date>
custom_date49
string or null <date>
custom_date5
string or null <date>
custom_date50
string or null <date>
custom_date6
string or null <date>
custom_date7
string or null <date>
custom_date8
string or null <date>
custom_date9
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_last_activity
string or null <date-time>
date_last_modified
string or null <date-time>
date_of_birth
string or null <date>
email
string or null
email2
string or null
email3
string or null
first_name
string or null
home_phone
string or null
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

last_name
string or null
mobile_phone
string or null
nick_name
string or null
opt_out_email
boolean or null
opt_out_sms
boolean or null
phone4
string or null
phone5
string or null
preferred_contact_method
string or null
source
string or null
state
string or null
status
string or null
title
string or null
work_phone
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve ClientContact details

Fetch details of a single ClientContact entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the ClientContact whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update ClientContact

Update single ClientContact entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the ClientContactwhose details need to be updated.

Request Body schema: application/json
active
boolean or null
address1
string or null
address2
string or null
city
string or null
company_id
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date10
string or null <date>
custom_date11
string or null <date>
custom_date12
string or null <date>
custom_date13
string or null <date>
custom_date14
string or null <date>
custom_date15
string or null <date>
custom_date16
string or null <date>
custom_date17
string or null <date>
custom_date18
string or null <date>
custom_date19
string or null <date>
custom_date2
string or null <date>
custom_date20
string or null <date>
custom_date21
string or null <date>
custom_date22
string or null <date>
custom_date23
string or null <date>
custom_date24
string or null <date>
custom_date25
string or null <date>
custom_date26
string or null <date>
custom_date27
string or null <date>
custom_date28
string or null <date>
custom_date29
string or null <date>
custom_date3
string or null <date>
custom_date30
string or null <date>
custom_date31
string or null <date>
custom_date32
string or null <date>
custom_date33
string or null <date>
custom_date34
string or null <date>
custom_date35
string or null <date>
custom_date36
string or null <date>
custom_date37
string or null <date>
custom_date38
string or null <date>
custom_date39
string or null <date>
custom_date4
string or null <date>
custom_date40
string or null <date>
custom_date41
string or null <date>
custom_date42
string or null <date>
custom_date43
string or null <date>
custom_date44
string or null <date>
custom_date45
string or null <date>
custom_date46
string or null <date>
custom_date47
string or null <date>
custom_date48
string or null <date>
custom_date49
string or null <date>
custom_date5
string or null <date>
custom_date50
string or null <date>
custom_date6
string or null <date>
custom_date7
string or null <date>
custom_date8
string or null <date>
custom_date9
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_last_activity
string or null <date-time>
date_last_modified
string or null <date-time>
date_of_birth
string or null <date>
email
string or null
email2
string or null
email3
string or null
first_name
string or null
home_phone
string or null
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

last_name
string or null
mobile_phone
string or null
nick_name
string or null
opt_out_email
boolean or null
opt_out_sms
boolean or null
phone4
string or null
phone5
string or null
preferred_contact_method
string or null
source
string or null
state
string or null
status
string or null
title
string or null
work_phone
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "company_id": "string",
  • "country": "string",
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_date1": "2019-08-24",
  • "custom_date10": "2019-08-24",
  • "custom_date11": "2019-08-24",
  • "custom_date12": "2019-08-24",
  • "custom_date13": "2019-08-24",
  • "custom_date14": "2019-08-24",
  • "custom_date15": "2019-08-24",
  • "custom_date16": "2019-08-24",
  • "custom_date17": "2019-08-24",
  • "custom_date18": "2019-08-24",
  • "custom_date19": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date20": "2019-08-24",
  • "custom_date21": "2019-08-24",
  • "custom_date22": "2019-08-24",
  • "custom_date23": "2019-08-24",
  • "custom_date24": "2019-08-24",
  • "custom_date25": "2019-08-24",
  • "custom_date26": "2019-08-24",
  • "custom_date27": "2019-08-24",
  • "custom_date28": "2019-08-24",
  • "custom_date29": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date30": "2019-08-24",
  • "custom_date31": "2019-08-24",
  • "custom_date32": "2019-08-24",
  • "custom_date33": "2019-08-24",
  • "custom_date34": "2019-08-24",
  • "custom_date35": "2019-08-24",
  • "custom_date36": "2019-08-24",
  • "custom_date37": "2019-08-24",
  • "custom_date38": "2019-08-24",
  • "custom_date39": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date40": "2019-08-24",
  • "custom_date41": "2019-08-24",
  • "custom_date42": "2019-08-24",
  • "custom_date43": "2019-08-24",
  • "custom_date44": "2019-08-24",
  • "custom_date45": "2019-08-24",
  • "custom_date46": "2019-08-24",
  • "custom_date47": "2019-08-24",
  • "custom_date48": "2019-08-24",
  • "custom_date49": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date50": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_date7": "2019-08-24",
  • "custom_date8": "2019-08-24",
  • "custom_date9": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "custom_text_block1": "string",
  • "custom_text_block2": "string",
  • "custom_text_block3": "string",
  • "custom_text_block4": "string",
  • "custom_text_block5": "string",
  • "custom_text_block6": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_last_activity": "2019-08-24T14:15:22Z",
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "date_of_birth": "2019-08-24",
  • "email": "string",
  • "email2": "string",
  • "email3": "string",
  • "first_name": "string",
  • "home_phone": "string",
  • "id": "string",
  • "internal_user_id": "string",
  • "internal_user_id2": "string",
  • "internal_user_id3": "string",
  • "is_archived": true,
  • "is_deleted": true,
  • "last_name": "string",
  • "mobile_phone": "string",
  • "nick_name": "string",
  • "opt_out_email": true,
  • "opt_out_sms": true,
  • "phone4": "string",
  • "phone5": "string",
  • "preferred_contact_method": "string",
  • "source": "string",
  • "state": "string",
  • "status": "string",
  • "title": "string",
  • "work_phone": "string",
  • "zipcode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a ClientContact field

Fetch the list of possible values configured for a field on the ClientContact entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a ClientContact field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Company

A company that is a client of your organization.

Upsert Company

Batch upsert Company entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
address1
string or null
address2
string or null
billing_phone
string or null
city
string or null
client_contact_id
string or null
company_name
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_last_modified
string or null <date-time>
department
string or null
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

phone
string or null
state
string or null
status
string or null
url
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve Company details

Fetch details of a single Company entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the Company whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update Company

Update single Company entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the Companywhose details need to be updated.

Request Body schema: application/json
address1
string or null
address2
string or null
billing_phone
string or null
city
string or null
client_contact_id
string or null
company_name
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_last_modified
string or null <date-time>
department
string or null
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

phone
string or null
state
string or null
status
string or null
url
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "billing_phone": "string",
  • "city": "string",
  • "client_contact_id": "string",
  • "company_name": "string",
  • "country": "string",
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_date1": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "custom_text_block1": "string",
  • "custom_text_block2": "string",
  • "custom_text_block3": "string",
  • "custom_text_block4": "string",
  • "custom_text_block5": "string",
  • "custom_text_block6": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "department": "string",
  • "id": "string",
  • "internal_user_id": "string",
  • "internal_user_id2": "string",
  • "internal_user_id3": "string",
  • "is_archived": true,
  • "is_deleted": true,
  • "phone": "string",
  • "state": "string",
  • "status": "string",
  • "url": "string",
  • "zipcode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a Company field

Fetch the list of possible values configured for a field on the Company entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a Company field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

InternalUser

An internal person at your organization.

Upsert InternalUser

Batch upsert InternalUser entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
active
boolean or null
address1
string or null
address2
string or null
city
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_last_activity
string or null <date-time>
date_last_modified
string or null <date-time>
date_of_birth
string or null <date>
department
string or null
email
string or null
email2
string or null
email3
string or null
first_name
string or null
home_phone
string or null
id
required
string non-empty
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

last_name
string or null
mobile_phone
string or null
nick_name
string or null
opt_out_email
boolean or null
opt_out_sms
boolean or null
phone4
string or null
phone5
string or null
preferred_contact_method
string or null
state
string or null
title
string or null
type
string or null
work_phone
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve InternalUser details

Fetch details of a single InternalUser entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the InternalUser whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update InternalUser

Update single InternalUser entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the InternalUserwhose details need to be updated.

Request Body schema: application/json
active
boolean or null
address1
string or null
address2
string or null
city
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
date_last_activity
string or null <date-time>
date_last_modified
string or null <date-time>
date_of_birth
string or null <date>
department
string or null
email
string or null
email2
string or null
email3
string or null
first_name
string or null
home_phone
string or null
id
required
string non-empty
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

last_name
string or null
mobile_phone
string or null
nick_name
string or null
opt_out_email
boolean or null
opt_out_sms
boolean or null
phone4
string or null
phone5
string or null
preferred_contact_method
string or null
state
string or null
title
string or null
type
string or null
work_phone
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "country": "string",
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_date1": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "custom_text_block1": "string",
  • "custom_text_block2": "string",
  • "custom_text_block3": "string",
  • "custom_text_block4": "string",
  • "custom_text_block5": "string",
  • "custom_text_block6": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_last_activity": "2019-08-24T14:15:22Z",
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "date_of_birth": "2019-08-24",
  • "department": "string",
  • "email": "string",
  • "email2": "string",
  • "email3": "string",
  • "first_name": "string",
  • "home_phone": "string",
  • "id": "string",
  • "is_archived": true,
  • "is_deleted": true,
  • "last_name": "string",
  • "mobile_phone": "string",
  • "nick_name": "string",
  • "opt_out_email": true,
  • "opt_out_sms": true,
  • "phone4": "string",
  • "phone5": "string",
  • "preferred_contact_method": "string",
  • "state": "string",
  • "title": "string",
  • "type": "string",
  • "work_phone": "string",
  • "zipcode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a InternalUser field

Fetch the list of possible values configured for a field on the InternalUser entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a InternalUser field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

JobOrder

A job to be filled by a Candidate.

Upsert JobOrder

Batch upsert JobOrder entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
address1
string or null
address2
string or null
benefits
string or null
bill_rate
number or null
categories
Array of strings or null
city
string or null
client_contact_id
string or null
client_contact_id2
string or null
client_contact_id3
string or null
company_id
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
(string or null) or (string or null)
date_last_modified
string or null <date-time>
(string or null) or (string or null)
description
string or null <= 1500000 characters
employment_type
string or null
id
required
string non-empty
industries
Array of strings or null
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

is_public
boolean or null
job_url
string or null
pay_rate
number or null
salary
number or null
shift
string or null
skills
Array of strings or null
source
string or null
specialties
Array of strings or null
state
string or null
status
string or null
title
string or null
type
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve JobOrder details

Fetch details of a single JobOrder entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the JobOrder whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update JobOrder

Update single JobOrder entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the JobOrderwhose details need to be updated.

Request Body schema: application/json
address1
string or null
address2
string or null
benefits
string or null
bill_rate
number or null
categories
Array of strings or null
city
string or null
client_contact_id
string or null
client_contact_id2
string or null
client_contact_id3
string or null
company_id
string or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
(string or null) or (string or null)
date_last_modified
string or null <date-time>
(string or null) or (string or null)
description
string or null <= 1500000 characters
employment_type
string or null
id
required
string non-empty
industries
Array of strings or null
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

is_public
boolean or null
job_url
string or null
pay_rate
number or null
salary
number or null
shift
string or null
skills
Array of strings or null
source
string or null
specialties
Array of strings or null
state
string or null
status
string or null
title
string or null
type
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "benefits": "string",
  • "bill_rate": 0,
  • "categories": [
    ],
  • "city": "string",
  • "client_contact_id": "string",
  • "client_contact_id2": "string",
  • "client_contact_id3": "string",
  • "company_id": "string",
  • "country": "string",
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_date1": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "custom_text_block1": "string",
  • "custom_text_block2": "string",
  • "custom_text_block3": "string",
  • "custom_text_block4": "string",
  • "custom_text_block5": "string",
  • "custom_text_block6": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_end": null,
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "date_start": null,
  • "description": "string",
  • "employment_type": "string",
  • "id": "string",
  • "industries": [
    ],
  • "internal_user_id": "string",
  • "internal_user_id2": "string",
  • "internal_user_id3": "string",
  • "is_archived": true,
  • "is_deleted": true,
  • "is_public": true,
  • "job_url": "string",
  • "pay_rate": 0,
  • "salary": 0,
  • "shift": "string",
  • "skills": [
    ],
  • "source": "string",
  • "specialties": [
    ],
  • "state": "string",
  • "status": "string",
  • "title": "string",
  • "type": "string",
  • "zipcode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a JobOrder field

Fetch the list of possible values configured for a field on the JobOrder entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a JobOrder field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Lead

A new prospective client or contact

Upsert Lead

Batch upsert Lead entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
address1
string or null
address2
string or null
city
string or null
company_id
string or null
consent
boolean or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date10
string or null <date>
custom_date11
string or null <date>
custom_date12
string or null <date>
custom_date13
string or null <date>
custom_date14
string or null <date>
custom_date15
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_date7
string or null <date>
custom_date8
string or null <date>
custom_date9
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime10
string or null <date-time>
custom_datetime11
string or null <date-time>
custom_datetime12
string or null <date-time>
custom_datetime13
string or null <date-time>
custom_datetime14
string or null <date-time>
custom_datetime15
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_datetime7
string or null <date-time>
custom_datetime8
string or null <date-time>
custom_datetime9
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer10
integer or null
custom_integer11
integer or null
custom_integer12
integer or null
custom_integer13
integer or null
custom_integer14
integer or null
custom_integer15
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_integer7
integer or null
custom_integer8
integer or null
custom_integer9
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
date_added
string or null <date-time>
date_last_modified
string or null <date-time>
description
string or null
division
string or null
email
string or null
email_opt_out
boolean or null
first_name
string or null
full_name
string or null
id
required
string non-empty
industry
string or null
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
internal_user_id4
string or null
internal_user_id5
string or null
internal_user_id6
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

last_name
string or null
mobile_phone
string or null
no_of_employees
integer or null
owner_id
string or null
phone
string or null
phone3
string or null
phone4
string or null
sms_opt_out
boolean or null
source
string or null
state
string or null
status
string or null
type
string or null
website
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve Lead details

Fetch details of a single Lead entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the Lead whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update Lead

Update single Lead entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the Leadwhose details need to be updated.

Request Body schema: application/json
address1
string or null
address2
string or null
city
string or null
company_id
string or null
consent
boolean or null
country
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date10
string or null <date>
custom_date11
string or null <date>
custom_date12
string or null <date>
custom_date13
string or null <date>
custom_date14
string or null <date>
custom_date15
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_date7
string or null <date>
custom_date8
string or null <date>
custom_date9
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime10
string or null <date-time>
custom_datetime11
string or null <date-time>
custom_datetime12
string or null <date-time>
custom_datetime13
string or null <date-time>
custom_datetime14
string or null <date-time>
custom_datetime15
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_datetime7
string or null <date-time>
custom_datetime8
string or null <date-time>
custom_datetime9
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer10
integer or null
custom_integer11
integer or null
custom_integer12
integer or null
custom_integer13
integer or null
custom_integer14
integer or null
custom_integer15
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_integer7
integer or null
custom_integer8
integer or null
custom_integer9
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
date_added
string or null <date-time>
date_last_modified
string or null <date-time>
description
string or null
division
string or null
email
string or null
email_opt_out
boolean or null
first_name
string or null
full_name
string or null
id
required
string non-empty
industry
string or null
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
internal_user_id4
string or null
internal_user_id5
string or null
internal_user_id6
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

last_name
string or null
mobile_phone
string or null
no_of_employees
integer or null
owner_id
string or null
phone
string or null
phone3
string or null
phone4
string or null
sms_opt_out
boolean or null
source
string or null
state
string or null
status
string or null
type
string or null
website
string or null
zipcode
string or null

Responses

Request samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "company_id": "string",
  • "consent": true,
  • "country": "string",
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_date1": "2019-08-24",
  • "custom_date10": "2019-08-24",
  • "custom_date11": "2019-08-24",
  • "custom_date12": "2019-08-24",
  • "custom_date13": "2019-08-24",
  • "custom_date14": "2019-08-24",
  • "custom_date15": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_date7": "2019-08-24",
  • "custom_date8": "2019-08-24",
  • "custom_date9": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime10": "2019-08-24T14:15:22Z",
  • "custom_datetime11": "2019-08-24T14:15:22Z",
  • "custom_datetime12": "2019-08-24T14:15:22Z",
  • "custom_datetime13": "2019-08-24T14:15:22Z",
  • "custom_datetime14": "2019-08-24T14:15:22Z",
  • "custom_datetime15": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_datetime7": "2019-08-24T14:15:22Z",
  • "custom_datetime8": "2019-08-24T14:15:22Z",
  • "custom_datetime9": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer10": 0,
  • "custom_integer11": 0,
  • "custom_integer12": 0,
  • "custom_integer13": 0,
  • "custom_integer14": 0,
  • "custom_integer15": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_integer7": 0,
  • "custom_integer8": 0,
  • "custom_integer9": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "division": "string",
  • "email": "string",
  • "email_opt_out": true,
  • "first_name": "string",
  • "full_name": "string",
  • "id": "string",
  • "industry": "string",
  • "internal_user_id": "string",
  • "internal_user_id2": "string",
  • "internal_user_id3": "string",
  • "internal_user_id4": "string",
  • "internal_user_id5": "string",
  • "internal_user_id6": "string",
  • "is_archived": true,
  • "is_deleted": true,
  • "last_name": "string",
  • "mobile_phone": "string",
  • "no_of_employees": 0,
  • "owner_id": "string",
  • "phone": "string",
  • "phone3": "string",
  • "phone4": "string",
  • "sms_opt_out": true,
  • "source": "string",
  • "state": "string",
  • "status": "string",
  • "type": "string",
  • "website": "string",
  • "zipcode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a Lead field

Fetch the list of possible values configured for a field on the Lead entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a Lead field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Placement

A job that has been filled by a Candidate.

Upsert Placement

Batch upsert Placement entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
bill_rate
number or null
candidate_id
string or null
client_contact_id
string or null
client_contact_id2
string or null
client_contact_id3
string or null
company_id
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date10
string or null <date>
custom_date11
string or null <date>
custom_date12
string or null <date>
custom_date13
string or null <date>
custom_date14
string or null <date>
custom_date15
string or null <date>
custom_date16
string or null <date>
custom_date17
string or null <date>
custom_date18
string or null <date>
custom_date19
string or null <date>
custom_date2
string or null <date>
custom_date20
string or null <date>
custom_date21
string or null <date>
custom_date22
string or null <date>
custom_date23
string or null <date>
custom_date24
string or null <date>
custom_date25
string or null <date>
custom_date26
string or null <date>
custom_date27
string or null <date>
custom_date28
string or null <date>
custom_date29
string or null <date>
custom_date3
string or null <date>
custom_date30
string or null <date>
custom_date31
string or null <date>
custom_date32
string or null <date>
custom_date33
string or null <date>
custom_date34
string or null <date>
custom_date35
string or null <date>
custom_date36
string or null <date>
custom_date37
string or null <date>
custom_date38
string or null <date>
custom_date39
string or null <date>
custom_date4
string or null <date>
custom_date40
string or null <date>
custom_date41
string or null <date>
custom_date42
string or null <date>
custom_date43
string or null <date>
custom_date44
string or null <date>
custom_date45
string or null <date>
custom_date46
string or null <date>
custom_date47
string or null <date>
custom_date48
string or null <date>
custom_date49
string or null <date>
custom_date5
string or null <date>
custom_date50
string or null <date>
custom_date6
string or null <date>
custom_date7
string or null <date>
custom_date8
string or null <date>
custom_date9
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
(string or null) or (string or null)
date_last_modified
string or null <date-time>
(string or null) or (string or null)
employment_type
string or null
fee
number or null
guarantee_days
integer or null
hours_per_day
integer or null
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

job_order_id
string or null
original_start_date
string or null <date>
overtime_bill_rate
number or null
overtime_pay_rate
number or null
pay_rate
number or null
salary
number or null
shift
string or null
status
string or null
submission_id
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve Placement details

Fetch details of a single Placement entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the Placement whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update Placement

Update single Placement entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the Placementwhose details need to be updated.

Request Body schema: application/json
bill_rate
number or null
candidate_id
string or null
client_contact_id
string or null
client_contact_id2
string or null
client_contact_id3
string or null
company_id
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date10
string or null <date>
custom_date11
string or null <date>
custom_date12
string or null <date>
custom_date13
string or null <date>
custom_date14
string or null <date>
custom_date15
string or null <date>
custom_date16
string or null <date>
custom_date17
string or null <date>
custom_date18
string or null <date>
custom_date19
string or null <date>
custom_date2
string or null <date>
custom_date20
string or null <date>
custom_date21
string or null <date>
custom_date22
string or null <date>
custom_date23
string or null <date>
custom_date24
string or null <date>
custom_date25
string or null <date>
custom_date26
string or null <date>
custom_date27
string or null <date>
custom_date28
string or null <date>
custom_date29
string or null <date>
custom_date3
string or null <date>
custom_date30
string or null <date>
custom_date31
string or null <date>
custom_date32
string or null <date>
custom_date33
string or null <date>
custom_date34
string or null <date>
custom_date35
string or null <date>
custom_date36
string or null <date>
custom_date37
string or null <date>
custom_date38
string or null <date>
custom_date39
string or null <date>
custom_date4
string or null <date>
custom_date40
string or null <date>
custom_date41
string or null <date>
custom_date42
string or null <date>
custom_date43
string or null <date>
custom_date44
string or null <date>
custom_date45
string or null <date>
custom_date46
string or null <date>
custom_date47
string or null <date>
custom_date48
string or null <date>
custom_date49
string or null <date>
custom_date5
string or null <date>
custom_date50
string or null <date>
custom_date6
string or null <date>
custom_date7
string or null <date>
custom_date8
string or null <date>
custom_date9
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
(string or null) or (string or null)
date_last_modified
string or null <date-time>
(string or null) or (string or null)
employment_type
string or null
fee
number or null
guarantee_days
integer or null
hours_per_day
integer or null
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

job_order_id
string or null
original_start_date
string or null <date>
overtime_bill_rate
number or null
overtime_pay_rate
number or null
pay_rate
number or null
salary
number or null
shift
string or null
status
string or null
submission_id
string or null

Responses

Request samples

Content type
application/json
{
  • "bill_rate": 0,
  • "candidate_id": "string",
  • "client_contact_id": "string",
  • "client_contact_id2": "string",
  • "client_contact_id3": "string",
  • "company_id": "string",
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_date1": "2019-08-24",
  • "custom_date10": "2019-08-24",
  • "custom_date11": "2019-08-24",
  • "custom_date12": "2019-08-24",
  • "custom_date13": "2019-08-24",
  • "custom_date14": "2019-08-24",
  • "custom_date15": "2019-08-24",
  • "custom_date16": "2019-08-24",
  • "custom_date17": "2019-08-24",
  • "custom_date18": "2019-08-24",
  • "custom_date19": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date20": "2019-08-24",
  • "custom_date21": "2019-08-24",
  • "custom_date22": "2019-08-24",
  • "custom_date23": "2019-08-24",
  • "custom_date24": "2019-08-24",
  • "custom_date25": "2019-08-24",
  • "custom_date26": "2019-08-24",
  • "custom_date27": "2019-08-24",
  • "custom_date28": "2019-08-24",
  • "custom_date29": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date30": "2019-08-24",
  • "custom_date31": "2019-08-24",
  • "custom_date32": "2019-08-24",
  • "custom_date33": "2019-08-24",
  • "custom_date34": "2019-08-24",
  • "custom_date35": "2019-08-24",
  • "custom_date36": "2019-08-24",
  • "custom_date37": "2019-08-24",
  • "custom_date38": "2019-08-24",
  • "custom_date39": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date40": "2019-08-24",
  • "custom_date41": "2019-08-24",
  • "custom_date42": "2019-08-24",
  • "custom_date43": "2019-08-24",
  • "custom_date44": "2019-08-24",
  • "custom_date45": "2019-08-24",
  • "custom_date46": "2019-08-24",
  • "custom_date47": "2019-08-24",
  • "custom_date48": "2019-08-24",
  • "custom_date49": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date50": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_date7": "2019-08-24",
  • "custom_date8": "2019-08-24",
  • "custom_date9": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "custom_text_block1": "string",
  • "custom_text_block2": "string",
  • "custom_text_block3": "string",
  • "custom_text_block4": "string",
  • "custom_text_block5": "string",
  • "custom_text_block6": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_end": null,
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "date_start": null,
  • "employment_type": "string",
  • "fee": 0,
  • "guarantee_days": 0,
  • "hours_per_day": 0,
  • "id": "string",
  • "internal_user_id": "string",
  • "internal_user_id2": "string",
  • "internal_user_id3": "string",
  • "is_archived": true,
  • "is_deleted": true,
  • "job_order_id": "string",
  • "original_start_date": "2019-08-24",
  • "overtime_bill_rate": 0,
  • "overtime_pay_rate": 0,
  • "pay_rate": 0,
  • "salary": 0,
  • "shift": "string",
  • "status": "string",
  • "submission_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a Placement field

Fetch the list of possible values configured for a field on the Placement entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a Placement field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Submission

Sending a Candidate’s info for additional review.

Upsert Submission

Batch upsert Submission entities.

Authorizations:
sense_bearer_auth
Request Body schema: application/json
Array ([ 1 .. 500 ] items)
bill_rate
number or null
candidate_id
string or null
client_contact_id
string or null
comments
string or null
company_id
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
(string or null) or (string or null)
(string or null) or (string or null)
date_last_modified
string or null <date-time>
(string or null) or (string or null)
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

job_order_id
string or null
owner_id
string or null
pay_rate
number or null
salary
number or null
sending_user_id
string or null
source
string or null
status
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Retrieve Submission details

Fetch details of a single Submission entity by its unique ID.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique ID of the Submission whose details need to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ],
  • "resource_id": "string"
}

Update Submission

Update single Submission entity.

Authorizations:
sense_bearer_auth
path Parameters
id
required
integer

The unique id of the Submissionwhose details need to be updated.

Request Body schema: application/json
bill_rate
number or null
candidate_id
string or null
client_contact_id
string or null
comments
string or null
company_id
string or null
custom_array1
Array of strings or null
custom_array2
Array of strings or null
custom_array3
Array of strings or null
custom_array4
Array of strings or null
custom_array5
Array of strings or null
custom_date1
string or null <date>
custom_date2
string or null <date>
custom_date3
string or null <date>
custom_date4
string or null <date>
custom_date5
string or null <date>
custom_date6
string or null <date>
custom_datetime1
string or null <date-time>
custom_datetime2
string or null <date-time>
custom_datetime3
string or null <date-time>
custom_datetime4
string or null <date-time>
custom_datetime5
string or null <date-time>
custom_datetime6
string or null <date-time>
custom_float1
number or null
custom_float2
number or null
custom_float3
number or null
custom_float4
number or null
custom_float5
number or null
custom_float6
number or null
custom_integer1
integer or null
custom_integer2
integer or null
custom_integer3
integer or null
custom_integer4
integer or null
custom_integer5
integer or null
custom_integer6
integer or null
custom_text1
string or null
custom_text10
string or null
custom_text11
string or null
custom_text12
string or null
custom_text13
string or null
custom_text14
string or null
custom_text15
string or null
custom_text16
string or null
custom_text17
string or null
custom_text18
string or null
custom_text19
string or null
custom_text2
string or null
custom_text20
string or null
custom_text21
string or null
custom_text22
string or null
custom_text23
string or null
custom_text24
string or null
custom_text25
string or null
custom_text26
string or null
custom_text27
string or null
custom_text28
string or null
custom_text29
string or null
custom_text3
string or null
custom_text30
string or null
custom_text31
string or null
custom_text32
string or null
custom_text33
string or null
custom_text34
string or null
custom_text35
string or null
custom_text36
string or null
custom_text37
string or null
custom_text38
string or null
custom_text39
string or null
custom_text4
string or null
custom_text40
string or null
custom_text41
string or null
custom_text42
string or null
custom_text43
string or null
custom_text44
string or null
custom_text45
string or null
custom_text46
string or null
custom_text47
string or null
custom_text48
string or null
custom_text49
string or null
custom_text5
string or null
custom_text50
string or null
custom_text6
string or null
custom_text7
string or null
custom_text8
string or null
custom_text9
string or null
custom_text_block1
string or null
custom_text_block2
string or null
custom_text_block3
string or null
custom_text_block4
string or null
custom_text_block5
string or null
custom_text_block6
string or null
date_added
string or null <date-time>
(string or null) or (string or null)
(string or null) or (string or null)
date_last_modified
string or null <date-time>
(string or null) or (string or null)
id
required
string non-empty
internal_user_id
string or null
internal_user_id2
string or null
internal_user_id3
string or null
is_archived
boolean or null
is_deleted
boolean or null

A soft DELETE Operation is supported if the field is_deleted = true

job_order_id
string or null
owner_id
string or null
pay_rate
number or null
salary
number or null
sending_user_id
string or null
source
string or null
status
string or null

Responses

Request samples

Content type
application/json
{
  • "bill_rate": 0,
  • "candidate_id": "string",
  • "client_contact_id": "string",
  • "comments": "string",
  • "company_id": "string",
  • "custom_array1": [
    ],
  • "custom_array2": [
    ],
  • "custom_array3": [
    ],
  • "custom_array4": [
    ],
  • "custom_array5": [
    ],
  • "custom_date1": "2019-08-24",
  • "custom_date2": "2019-08-24",
  • "custom_date3": "2019-08-24",
  • "custom_date4": "2019-08-24",
  • "custom_date5": "2019-08-24",
  • "custom_date6": "2019-08-24",
  • "custom_datetime1": "2019-08-24T14:15:22Z",
  • "custom_datetime2": "2019-08-24T14:15:22Z",
  • "custom_datetime3": "2019-08-24T14:15:22Z",
  • "custom_datetime4": "2019-08-24T14:15:22Z",
  • "custom_datetime5": "2019-08-24T14:15:22Z",
  • "custom_datetime6": "2019-08-24T14:15:22Z",
  • "custom_float1": 0,
  • "custom_float2": 0,
  • "custom_float3": 0,
  • "custom_float4": 0,
  • "custom_float5": 0,
  • "custom_float6": 0,
  • "custom_integer1": 0,
  • "custom_integer2": 0,
  • "custom_integer3": 0,
  • "custom_integer4": 0,
  • "custom_integer5": 0,
  • "custom_integer6": 0,
  • "custom_text1": "string",
  • "custom_text10": "string",
  • "custom_text11": "string",
  • "custom_text12": "string",
  • "custom_text13": "string",
  • "custom_text14": "string",
  • "custom_text15": "string",
  • "custom_text16": "string",
  • "custom_text17": "string",
  • "custom_text18": "string",
  • "custom_text19": "string",
  • "custom_text2": "string",
  • "custom_text20": "string",
  • "custom_text21": "string",
  • "custom_text22": "string",
  • "custom_text23": "string",
  • "custom_text24": "string",
  • "custom_text25": "string",
  • "custom_text26": "string",
  • "custom_text27": "string",
  • "custom_text28": "string",
  • "custom_text29": "string",
  • "custom_text3": "string",
  • "custom_text30": "string",
  • "custom_text31": "string",
  • "custom_text32": "string",
  • "custom_text33": "string",
  • "custom_text34": "string",
  • "custom_text35": "string",
  • "custom_text36": "string",
  • "custom_text37": "string",
  • "custom_text38": "string",
  • "custom_text39": "string",
  • "custom_text4": "string",
  • "custom_text40": "string",
  • "custom_text41": "string",
  • "custom_text42": "string",
  • "custom_text43": "string",
  • "custom_text44": "string",
  • "custom_text45": "string",
  • "custom_text46": "string",
  • "custom_text47": "string",
  • "custom_text48": "string",
  • "custom_text49": "string",
  • "custom_text5": "string",
  • "custom_text50": "string",
  • "custom_text6": "string",
  • "custom_text7": "string",
  • "custom_text8": "string",
  • "custom_text9": "string",
  • "custom_text_block1": "string",
  • "custom_text_block2": "string",
  • "custom_text_block3": "string",
  • "custom_text_block4": "string",
  • "custom_text_block5": "string",
  • "custom_text_block6": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "date_application": null,
  • "date_end": null,
  • "date_last_modified": "2019-08-24T14:15:22Z",
  • "date_start": null,
  • "id": "string",
  • "internal_user_id": "string",
  • "internal_user_id2": "string",
  • "internal_user_id3": "string",
  • "is_archived": true,
  • "is_deleted": true,
  • "job_order_id": "string",
  • "owner_id": "string",
  • "pay_rate": 0,
  • "salary": 0,
  • "sending_user_id": "string",
  • "source": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Get possible values for a Submission field

Fetch the list of possible values configured for a field on the Submission entity. These values define dropdown options used in various Sense workflows.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name for which possible values should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Update possible values for a Submission field

A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.

Authorizations:
sense_bearer_auth
path Parameters
fieldName
required
string

The field name whose possible values should be updated.

Request Body schema: application/json
Array
label
required
string
required
string or number or boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "resource_id": "string"
}

Write-back API Specification

Version: 2025-01-29

Previous Versions

  • 2020-11-18
  • 2021-07-21
  • 2022-01-15
  • 2022-02-11
  • 2022-10-21
  • 2025-01-29

Purpose

Sense supports sending a variety of information back to customers using a writeback system. Events in Sense generate and enqueue write-backs for dispatch to customer supported APIs. Traditionally, these APIs are managed by major ATSs, but in some cases, they are individually managed systems.

This document is meant to serve as a guide for an implementation of a pushbased write-back API to receive Sense events.

Summary

  1. API must support the RESTful paradigm
  2. API should support some authentication and authorization mechanism
  3. API must support encrypted transport via HTTPS
  4. API must support SSL version TLSv1.2
  5. API must accept JSON data payloads
  6. API must emit proper status codes to communicate client or server errors, or successful communication
  7. API must return an id if the write-back is successfully received

Important: Non-2xx responses or 2xx responses without an id will be considered failures. The Sense write-back sending service will attempt re-delivery of any failed write-back.

API Structure

New API

Accepts write-back details (candidate id, type, etc) and a session key or bearer token. This API should return an id if and only if a write-back is successfully received. Any other state should return a non-200 status code with an explanation. Sense will attempt to resend any write-backs which have not generated a 200 response code and an id .

URL

Sense requires a URL to send all write-backs, it can be one of almost any format other than it cannot require any variable information to be provided for each writeback.

Valid Urls

Example 1: https://www.yourserver.com/event 
Example 2: https://www.yourserver.com/new/event?key=12345 // where the key is the same for every request

Invalid Url

Example: https://www.yourserver.com/event/{candidate_id} 
// where candidate id would need to be added at time of 
// write-back send and would depend on the receiving entity

Detailed Api Information

Authentication

Sense write-back API supports two kinds of authentication:

  1. Bearer Tokens
  2. OpenID Connect (OIDC)

Bearer Tokens

This is a pre-shared key that is embedded in every request from Sense to the recipient API. This token can either be placed in the header information or in the query parameter of the API URL. Customers can choose where they would like this token to be placed. The token should be sufficiently long to prevent anyone from guessing it. It can also be replaced at the customers discretion.

URL based example:

Token = "123412341234" 
Write-back URL = "https://www.yourserver.com/event?token= 123412341234"

Header based example:

Token = "Bearer 123412341234"
Write-back URL = "https://www.yourserver.com/event" 
curl --location --request POST \ 'https://www.yourserver.com/event' \ --header 'Authorization: Bearer 123412341234' --data-raw '{WRITE_BACK}'

Openid Connect (OIDC)

In order to use this feature for authentication (and potentially authorization), a customer must provide Sense with a "well-known" OpenId Connect URL. This URL is in addition to the Event URL .

OAuth2

Similarly, Sense also supports OAuth2 for authentication. Sense would need:

  1. OAuth2 Authentication URL
  2. OAuth2 Scope
  3. Client ID
  4. Client Secret

Authentication Tokens will be passed in the Authorization header with Bearer as a prefix.

Example: Authorization: Bearer 123412341234

Note: Sense only supports CLIENT CREDENTIALS Grant Type

New API

  • HTTP method: POST
  • URL: <CLIENT_URL>
  • ENCRYPTION: HTTPS

Headers:

  • Content-type: application/json

Body: Every write-back will have the following outer envelop information. The information contained in "data" will be different depending on the event type. Each write-back type is described in the Data Structures section.

{ 
    "id": "xxxxxxxxx",
    "type": SenseWriteBackType, // defined in `Data Structures` 
    "version": 1.0, 
    "created_date": "2018-12-18T03:33:46+00:00", 
    "data": <CUSTOM_PER_TYPE> // see `Data Structures` 
}

Returns (on success): Status code: 200

{ 
    "id": "<unique_id>" 
}

Returns (on failure to process because of invalid authentication and/or authorization):

Status code: 401

{ 
    "error": "invalid token or session" 
}

Returns (on failure to process because of inputs):

Status code: 4xx

{ 
    "error": "unable to store because of field x,y,z" 
}

Returns (on failure to process because of server issues): Status code: 5xx

{ 
    "error": "unable to store, server issue x,y,z" 
}

Helper Data Structures

These objects are embedded in the data structures.

Sense Write-back Type

This is an enumerated type and will be passed in a JSON string field.

SenseWriteBackType = [ 
    ENGAGE_SENT_EVENT, 
    ENGAGE_EVENT_RESPONSE, 
    MESSAGING_INCOMING_MESSAGE, 
    MESSAGING_OUTGOING_MESSAGE, 
    MESSAGING_DIGEST, 
    CHATBOT_RESPONSE_SUMMARY, 
    ENTITY_CREATE, 
    ENTITY_UPDATE, 
    ENTITY_DELETE, 
    GENERIC_EVENT 
]

Changelog

2021-07-16

Response ID field changed from note_id to id.

2021-07-21

Added MESSAGING_DIGEST, CHATBOT_CONVERSATION, FIELD_UPDATE, GENERIC_EVENT

2022-02-11

Changed CHATBOT_CONVERSATION to CHATBOT_RESPONSE_SUMMARY

2022-10-21

Added OBJECT_CREATE, OBJECT_UPDATE, OBJECT_DELETE. Removed FIELD_UPDATE.

2022-11-30

Renamed OBJECT_CREATE, OBJECT_UPDATE, OBJECT_DELETE to ENTITY_CREATE, ENTITY_UPDATE, ENTITY_DELETE

Sense Entity Type

This is an enumerated type and will be passed in a JSON string field.

SenseEntityType = [ 
    AE_APPOINTMENT, 
    AE_CANDIDATE, 
    AE_CERTIFICATION, 
    AE_CLIENT_CONTACT, 
    AE_COMPANY, 
    AE_INTERNAL_USER, 
    AE_JOB_ORDER, 
    AE_PLACEMENT, 
    AE_SUBMISSION 
]

Entity Object

EntityObject = { 
    "id": "", // the ATSs ID for the entity 
    "type": SenseEntityType 
}

Actor Object

ActorObject = { 
    "entity": EntityObject 
    "email": "xxxx@xxxx.com", 
    "phone": "+x-xxx-xxx-xxxx" 
}

SMS Object

SMSObject = { 
    "to": [ActorObject], 
    "from": ActorObject, 
    "body": "", 
    "date": "", 
    "direction": "", // can be ["incoming" or "outgoing"] 
    "mms_urls": [""], 
    "is_broadcast": boolean 
}

Changelog

2022-02-11

is_broadcast added to documentation

Email Object

EmailObject = { 
    "to": [ActorObject], 
    "from": ActorObject, 
    "reply-to": ActorObject, 
    "bcc": [ActorObject], 
    "cc": [ActorObject],
    "date": "", 
    "direction": "", // can be ["incoming" or "outgoing"] 
    "is_alert_email": Boolean 
    "subject": "", 
    "body": "", 
    "mms_urls": [""] 
}

Field Object

FieldObject = { 
    "name": "", // field name 
    "value": "", // new value 
}

Conversation Object

ConversationObject = { 
    "sender": EntityObject, // can be Null if "is_bot" is True 
    "is_bot": True, // True or False 
    "message": "", 
    "date": "" // ISO datetime 
}

Changelog

2021-07-21

Added FieldUpdateObject 2022-02-11

Changed entity key name to sender

Data Structures

Information included with every write-back

The outer most container of the write-back includes data common to all write-backs

  1. id: A unique ID to all write-backs
  2. type: The write-back type. For example: "engage_sent_event". For a complete list, see Sense Write-back Types
  3. version: The schema version for each write-back type. Note: major revisions (numbers 1 or greater) are reserved for breaking changes in the specification, minor revisions (numbers less than 1 but greater than 0) are "non-breaking"
  4. created_date: An ISO8601 datestamp for when the write-back was created in Sense
  5. data: The object that contains event specific information
    {
 "id": "xxxxxx",  // unique sense ID for the write-back
 "type": SenseWriteBackType,  // always set by sense
 "version": 1.0,  // help ATSs handle new definitions
 "created_date": "2018-12-18T03:33:46+00:00", // date write-back created, ISO8601
 "data": {...}
}

    Example Type: Engage Sent Event

This is an example of the Engage Sent Event write-back type.

{ 
    "id": "xxxxxx", // unique sense ID for the write-back 
    "type": "ENGAGE_SENT_EVENT", // always set by sense
    "version": 1.0, // help ATSs handle new definitions 
    "created_date": "2018-12-18T03:33:46+00:00", // date write-back created, ISO8601 
    "data": { 
        "sms": [SMSObject], 
        "email": [EmailObject], 
        "summary": "", // a human readable version of // the write-back, generated by Sense 
        "user_defined_data": { 
            "note_type": "" // can be set per agency 
        }, 
        "associated_entities": [EntityObject], 
        "sense_meta_data": { 
            "event": { 
                "id": "", // unique identifier in Sense for // origin of the write-back 
                "type": "engage_sent_event" // unique identifier type in Sense // for origin of the write-back 
            }, 
            "journey": { 
                "id": "", 
                "name":"" 
            }, 
            "touchpoint": { 
                "id": "", 
                "name":"", 
                "type":"" 
            }, 
        } 
    } 
}

  1. sms: If the event included any SMS messages, they will be included in this list. SMSObjects are defined in Data Structures.

  2. email: If the event included any Email messages, they will be included in this list. EmailObjects are defined in Data Structures.

  3. summary: This field contains a human readable version of the contents of the event. This is currently pre-defined for all write-back types. Sense delimits new-lines for this text field with "\n".

  4. user_defined_data: This field allows for key-value pair data. Customers can request both customized key and value information. Any data the customer passes along from their ATS, CSVs, or manually entered into Sense can be passed along in the user_defined_data field. Some coordination is required for new fields and some data may not be available for every event, depending on the type of event generating the write-back.

  5. associated_entities: associated_entities contains a list of EntityObjects and is meant to indicate entities related to this event. For example, for a placement based journey, while a candidate may be the recipient of an email from the event, the placement could be included as an associated entity.

  6. sense_meta_data: sense_meta_data contains named objects based on internal structures, actors, and/or other data core to Sense. Common fields are: journey, touchpoint, and data_cleanup. These objects will contain information like IDs, human-readable names, and type information. This information can help your organization understand how and where in the Sense ecosystem the events underlying all write-backs are generated.

Engage Event Response

{
    "id": "xxxxxx",
    "type": "ENGAGE_EVENT_RESPONSE",
    "version": 1.0,
    "created_date": "2022-01-01T00:00:00+00:00",
    "data": { 
        "sms": [SMSObject],
        "email": [EmailObject], 
        "summary": "", 
        "survey_responses": [ 
            { 
                "question": "", 
                "response": "" 
            } 
        ], 
        "user_defined_data": { 
            "note_type": "", 
            "exampleKey": "exampleValue" 
        }, 
        "associated_entities": [EntityObject], 
        "sense_meta_data": { 
            "event": { 
                "id": "", 
                "type": "engage_event_response" 
            }, 
            "journey": { 
                "id": "", 
                "name":"" 
            }, 
            "touchpoint": { 
                "id": "", 
                "name":"", 
                "type":"" 
            }, 
        } 
    } 
}

Messaging Incoming SMS

{ 
    "id": "xxxxxx", 
    "type": "MESSAGING_INCOMING_MESSAGE", 
    "version": 1.1, 
    "created_date": "2022-01-01T00:00:00+00:00", 
    "data": { 
        "sms": [SMSObject], 
        "summary": "...", 
        "user_defined_data": { 
            "note_type": "", 
            "exampleKey": "exampleValue" 
        }, 
        "associated_entities": [EntityObject], 
        "sense_meta_data": { 
            "event": { 
                "id": "", 
                "type": "messaging_message" 
            }
        }
    }
}

Changelog

1.1

  • Added "is_broadcast" to SMSObject

Messaging Outgoing SMS

{
      "id": "xxxxxx"
      "type": "MESSAGING_OUTGOING_MESSAGE",
      "version": 1.1,
      "created_date": "2022-01-01T00:00:00+00:00",
      "data": {
          "sms": [SMSObject],
          "summary": "...",
          "is_broadcast": True,  // can be [True, False]
Added "is_broadcast" to SMSObject
 
           "user_defined_data": {
              "exampleKey": "exampleValue"
          },
          "associated_entities": [EntityObject],
          "sense_meta_data": {
              "event": {
                  "id": "",
                  "type": "messaging_message"
              }
          }
      }
}

Changelog

1.1

  • Added "is_broadcast" to SMSObject

    Messaging Digest

{ 
    "id": "xxxxxx", 
    "type": "MESSAGING_DIGEST", 
    "version": 1.0, 
    "created_date": "2022-01-01T00:00:00+00:00", 
    "data": { 
        "sms": [SMSObject], 
        "summary": "...", 
        "user_defined_data": { 
            "exampleKey": "exampleValue" 
        }, 
        "associated_entities": [EntityObject], 
        "sense_meta_data": { 
            "event": { 
                "id": "", 
                "type": "messaging_digest" 
            } 
        } 
    } 
}

Changelog

2021-07-21

Added Messaging Digest

Chatbot Conversation

{ 
    "id": "xxxxxx", 
    "type": "CHATBOT_RESPONSE_SUMMARY", 
    "version": 1.0, 
    "created_date": "2022-01-01T00:00:00+00:00", 
    "data": { 
        "summary": "...", 
        "subject": EntityObject, // the note's entity 
        "conversation": [ConversationObject], 
        "user_defined_data": { 
            "exampleKey": "exampleValue" 
        }, 
        "entity":"" // The entity type of the flow 
    } 
}

Changelog

2021-07-21

Added Chatbot Conversation

2022-02-11 Added "subject": EntityObject to documentation

Entity Create

{
      "id": "xxxxxx"
      "type": "ENTITY_CREATE",
      "version": 1.0,
      "created_date": "2022-01-01T00:00:00+00:00",
      "data": {
          "entity_type": SenseEntityType,
          "fields": [FieldObject],
          "user_defined_data": {
              "exampleKey": "exampleValue"
          },
          "associated_entities": [EntityObject],
          "sense_meta_data": {}
      }
}

Response

The response for the Entity Create request MUST also contain the entity id of the newly created entity.

Here is an example payload: { "id": "", // Event ID in API, used for debugging "entity_id": "" // ID of newly created Entity }

Changelog

2022-10-21

Added Object Create

2022-11-30

Renamed to Entity Create, renamed object_type to entity_type , and added Response information

Entity Update

{ 
    "id": "xxxxxx", 
    "type": "ENTITY_UPDATE", 
    "version": 1.0, 
    "created_date": "2022-01-01T00:00:00+00:00", 
    "data": { 
        "entity": EntityObject, 
        "fields": [FieldObject], 
        "user_defined_data": { "exampleKey": "exampleValue" }, 
        "associated_entities": [EntityObject], 
        "sense_meta_data": {} 
    } 
}

2022-10-21

Added Object Update

2022-11-30

Renamed to Entity Update, renamed object_type to entity_type , and added Response information

Entity Delete

{
    "id": "xxxxxx",
    "type": "ENTITY_DELETE",
    "version": 1.0,
    "created_date": "2022-01-01T00:00:00+00:00",
    "data": {
        "entity": EntityObject,
        "user_defined_data": {
            "exampleKey": "exampleValue"
        },
        "associated_entities": [EntityObject],
        "sense_meta_data": {}
    }
}

Changelog

2022-10-21

Added Object Delete

2022-11-30

Renamed to Entity Delete, renamed object_id and object_type to entity and set its value to EntityObject

Generic Event

{ 
    "id": "xxxxxx", 
    "type": "GENERIC_EVENT",
    "version": 1.0,
    "created_date": "2022-01-01T00:00:00+00:00",
    "data": {
        "summary": "...",
        "subject": EntityObject,  // the note's entity
        "user_defined_data": {
            "exampleKey": "exampleValue"
        },
        "associated_entities": [EntityObject],
        "sense_meta_data": {
            "event": {
                "id": "",
                "type": "" 
            }
        }
    }
}

Changelog

2021-07-21

Added Generic Event