Skip to main content
GET
/
api
/
ats
/
v1
/
activities
/
{id}
Get Activity By Id
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/activities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "user": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "activity_type": "NOTE",
  "subject": "Interview with John Doe",
  "body": "John Doe was interviewed for the position of Software Engineer.",
  "visibility": "PUBLIC",
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "remote_created_at": "2021-07-01T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-connector-token
string
required

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
include_raw_data
boolean
default:false

Include raw data in the response

Example:

false

​
include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

​
expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:

"manager[first_name,last_name]"

Response

Successful Response

The activity object is used to represent any activity in the ATS.

​
id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

​
remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

​
modified_at
string
required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

​
custom_fields
Custom Fields · object
required

The custom fields related to the model

Example:
{
  "category_group": "REG",
  "disability_type": "ASBERG",
  "hire_date": "1991-03-16T00:00:00",
  "hire_source": "REFER",
  "nationality": "USA",
  "original_hire_date": "1991-03-16T00:00:00"
}
​
user
any | null
required

The user who owns the activity.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

​
activity_type
enum<string>
required

The type of activity. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
NOTE,
EMAIL,
OTHER
Example:

"NOTE"

​
subject
string | null
required

The subject of the activity.

Example:

"Interview with John Doe"

​
body
string | null
required

The body of the activity. This can include notes, comments, or other relevant information.

Example:

"John Doe was interviewed for the position of Software Engineer."

​
visibility
enum<string>
required

Visibility of the activity. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
ADMIN_ONLY,
PUBLIC,
PRIVATE
Example:

"PUBLIC"

​
candidate
any | null
required

Candidate who applied for the activity.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

​
remote_created_at
string | null
required

When the third party's candidate was created.

Example:

"2021-07-01T00:00:00Z"

​
raw_data
Raw Data · object

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}