Activities

The Activity object is used to represent an activity performed by a user.

The Activity object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

userString
Optional

remote_created_atString
Optional
When the third party's activity was created.

activity_typeEnum
Optional
The activity's type. Possible values include: NOTE, EMAIL, OTHER, or - in cases where there is no clear mapping - the original value passed through.

subjectString
Optional
The activity's subject.

bodyString
Optional
The activity's body.

visibilityEnum
Optional
The activity's visibility. Possible values include: ADMIN_ONLY, PUBLIC, PRIVATE, or - in cases where there is no clear mapping - the original value passed through.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted on the third-party.

The Activity object
JSON
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "198123",
"user": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
"remote_created_at": "2021-10-15T00:00:00Z",
"activity_type": "NOTE",
"subject": "Gil Feig's interview",
"body": "Candidate loves integrations!!.",
"visibility": "PRIVATE",
"remote_was_deleted": true
}

GET

/activities

Returns a list of Activity objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was deleted in the third-party service.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

user_idString
Optional
If provided, will only return activities done by this user.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "198123",
"user": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
"remote_created_at": "2021-10-15T00:00:00Z",
"activity_type": "NOTE",
"subject": "Gil Feig's interview",
"body": "Candidate loves integrations!!.",
"visibility": "PRIVATE",
"remote_was_deleted": true
}
]
}
Field support by platform

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

subjectString

remote_created_atString

userString

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

subjectString

remote_created_atString

remote_idString

userString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

subjectString

remote_created_atString

remote_idString

userString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

userString

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

subjectString

remote_created_atString

Jobscore

Jobscore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


visibilityEnum

bodyString

activity_typeEnum

remote_created_atString

remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


visibilityEnum

bodyString

activity_typeEnum

userString

remote_created_atString

remote_idString

subjectString

Homerun

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


visibilityEnum

bodyString

activity_typeEnum

subjectString

remote_created_atString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

subjectString

remote_created_atString

userString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


visibilityEnum

bodyString

activity_typeEnum

subjectString

userString

remote_idString

remote_created_atString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

userString

subjectString

remote_idString

remote_created_atString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

subjectString

remote_created_atString

remote_idString

userString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/activities/{id}

Returns an Activity object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "198123",
"user": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
"remote_created_at": "2021-10-15T00:00:00Z",
"activity_type": "NOTE",
"subject": "Gil Feig's interview",
"body": "Candidate loves integrations!!.",
"visibility": "PRIVATE",
"remote_was_deleted": true
}
Field support by platform

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

subjectString

remote_created_atString

userString

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

subjectString

remote_created_atString

remote_idString

userString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

subjectString

remote_created_atString

remote_idString

userString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

userString

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

subjectString

remote_created_atString

Jobscore

Jobscore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


visibilityEnum

bodyString

activity_typeEnum

remote_created_atString

remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


visibilityEnum

bodyString

activity_typeEnum

userString

remote_created_atString

remote_idString

subjectString

Homerun

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


visibilityEnum

bodyString

activity_typeEnum

subjectString

remote_created_atString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

activity_typeEnum

subjectString

remote_created_atString

userString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


visibilityEnum

bodyString

activity_typeEnum

subjectString

userString

remote_idString

remote_created_atString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

userString

subjectString

remote_idString

remote_created_atString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

subjectString

remote_created_atString

remote_idString

userString
Hint: Use the /linked-accounts endpoint to pull platform support information.