Activities
The
Activity object is used to represent an activity for a candidate performed by a user.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
userUUIDOptional
The user that performed the action.
remote_created_atDateTime (ISO 8601)Optional
When the third party's activity was created.
activity_typeEnumOptional
The activity's type. Possible values include:
NOTE, EMAIL, OTHER. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.subjectStringOptional
The activity's subject.
bodyStringOptional
The activity's body.
visibilityEnumOptional
The activity's visibility. Possible values include:
ADMIN_ONLY, PUBLIC, PRIVATE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.candidateUUIDOptional
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/activities
https://api.merge.dev/api/ats/v1/activities
US
EU
APAC
Returns a list of Activity objects.
Query & Path Parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
user_idStringOptional
If provided, will only return activities done by this user.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ApplicantStack
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsubjectStringuserUUID
Ashby
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringuserUUID
CATS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUID
Fountain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUID
Greenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUIDvisibilityEnum
Homerun
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsubjectStringvisibilityEnum
JazzHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUID
JobScore
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringuserUUIDvisibilityEnum
Lever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUIDvisibilityEnum
Manatal
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectString
Sage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsubjectString
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringuserUUID
Teamtailor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUID
Traffit
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
UKG Pro Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringuserUUID
Workable
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsubjectStringuserUUIDPOST
/activities
Betahttps://api.merge.dev/api/ats/v1/activities
US
EU
APAC
Creates an Activity object with the given values.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
remote_user_idStringRequired
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.userUUIDThe user that performed the action. Must pass in a valid Merge ID, which can be obtained from the
id field in the RemoteUser object.activity_typeEnumThe activity's type. Must pass in one of the following choices:
NOTE, EMAIL, OTHER.subjectStringThe activity's subject.
bodyStringThe activity's body.
visibilityEnumThe activity's visibility. Must pass in one of the following choices:
ADMIN_ONLY, PUBLIC, PRIVATE.candidateUUID Must pass in a valid Merge ID, which can be obtained from the
id field in the Candidate object. For specified integrations, you may pass in the Candidate model directly and Merge will automatically handle deduplication of existing objects.integration_paramsObjectlinked_account_paramsObjectField support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Ashby
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
candidateUUIDOptional
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
userUUIDOptional
Additional POST Parameters
integration_paramsObjectRequired
candidate_merge_idStringRequired
Greenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumRequired
bodyStringOptional
candidateUUIDRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
subjectStringOptional
userUUIDOptional
visibilityEnumOptional
Infinite BrassRing
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
candidateUUIDRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
JobAdder
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
userUUIDOptional
Additional POST Parameters
integration_paramsObjectRequired
candidate_merge_idStringRequired
Lever
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
candidateUUIDOptional
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
candidate_idStringRequired
candidate_merge_idStringRequired
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
candidateUUIDRequired
remote_idStringOptional
UKG Pro Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
bodyStringRequired
candidateUUIDRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
userUUIDRequired
To include the correct model fields when making POST requests, use the GET /activities/meta/post endpoint. Learn more in our /meta guide.
GET
/activities/{id}
https://api.merge.dev/api/ats/v1/activities/{id}
US
EU
APAC
Returns an Activity object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ApplicantStack
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsubjectStringuserUUIDAshby
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringuserUUIDCATS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUIDFountain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUIDGreenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUIDvisibilityEnumHomerun
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsubjectStringvisibilityEnumJazzHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUIDJobScore
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringuserUUIDvisibilityEnumLever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUIDvisibilityEnumManatal
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringSage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsubjectStringSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringuserUUIDTeamtailor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringuserUUIDTraffit
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringUKG Pro Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringuserUUIDWorkable
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
activity_typeEnumbodyStringcandidateUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsubjectStringuserUUIDGET
/activities/meta/post
https://api.merge.dev/api/ats/v1/activities/meta/post
US
EU
APAC
Returns metadata for Activity POSTs.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Ashby
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
candidateUUIDOptional
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
userUUIDOptional
Additional POST Parameters
integration_paramsObjectRequired
candidate_merge_idStringRequired
Greenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumRequired
bodyStringOptional
candidateUUIDRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
subjectStringOptional
userUUIDOptional
visibilityEnumOptional
Infinite BrassRing
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
candidateUUIDRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
JobAdder
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
userUUIDOptional
Additional POST Parameters
integration_paramsObjectRequired
candidate_merge_idStringRequired
Lever
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
candidateUUIDOptional
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
candidate_idStringRequired
candidate_merge_idStringRequired
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
activity_typeEnumOptional
bodyStringRequired
candidateUUIDRequired
remote_idStringOptional
UKG Pro Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
bodyStringRequired
candidateUUIDRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
userUUIDRequired