Activity
object is used to represent an activity for a candidate performed by a user.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)user
UUIDremote_created_at
DateTime (ISO 8601)activity_type
EnumNOTE
, EMAIL
, OTHER
. In cases where there is no clear mapping, the original value passed through will be returned.subject
Stringbody
Stringvisibility
EnumADMIN_ONLY
, PUBLIC
, PRIVATE
. In cases where there is no clear mapping, the original value passed through will be returned.candidate
UUIDremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/ats/v1/activities
Returns a list of Activity
objects.
created_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
Stringuser_id
String![ApplicantStack](https://merge-api-production.s3.amazonaws.com/media/ApplicantStack_Square_Logo_wBHYVRL.jpg)
Supported Response Fields
activity_type
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsubject
Stringuser
UUID![Ashby](https://merge-api-production.s3.amazonaws.com/media/Ashby_Square_Logo_3uQWavw.png)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringuser
UUID![CATS](https://merge-api-production.s3.amazonaws.com/media/CATS_Square_Logo_J4NkqoE.jpg)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUID![Fountain](https://merge-api-production.s3.amazonaws.com/media/Fountain_Square_Logo.png)
Supported Response Fields
activity_type
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUID![Greenhouse](https://merge-api-production.s3.amazonaws.com/media/Greenhouse_Square_Logo.jpg)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUIDvisibility
Enum![Homerun](https://merge-api-production.s3.amazonaws.com/media/homerun.png)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsubject
Stringvisibility
Enum![JazzHR](https://merge-api-production.s3.amazonaws.com/media/JazzHR_Square_Logo_WQcMDMd.jpg)
Supported Response Fields
activity_type
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUID![JobScore](https://merge-api-production.s3.amazonaws.com/media/JobScore-square.png)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringuser
UUIDvisibility
Enum![Lever](https://merge-api-production.s3.amazonaws.com/media/Lever_Square_Logo_oYg8yBW.jpg)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUIDvisibility
Enum![Sage HR](https://merge-api-production.s3.amazonaws.com/media/Sage_Square_Logo_FAQpKpP.jpg)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsubject
String![SAP SuccessFactors](https://merge-api-production.s3.amazonaws.com/media/SuccessFactors_Square_Logo_BcXogF0.jpg)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringuser
UUID![Teamtailor](https://merge-api-production.s3.amazonaws.com/media/Teamtailor_Square_Logo.jpg)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUID![UKG Pro Recruiting](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_zTMYILE.png)
Supported Response Fields
body
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringuser
UUID![Workable](https://merge-api-production.s3.amazonaws.com/media/Workable_Square_Logo_OvllNl9.jpg)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsubject
Stringuser
UUIDhttps://api.merge.dev/api/ats/v1/activities
Creates an Activity
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectremote_user_id
Stringuser
UUIDid
field in the RemoteUser object.activity_type
EnumNOTE
, EMAIL
, OTHER
.subject
Stringbody
Stringvisibility
EnumADMIN_ONLY
, PUBLIC
, PRIVATE
.candidate
UUIDid
field in the Candidate object.integration_params
Objectlinked_account_params
Object![Ashby](https://merge-api-production.s3.amazonaws.com/media/Ashby_Square_Logo_3uQWavw.png)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
Stringuser
UUIDAdditional POST Parameters
integration_params
Objectcandidate_merge_id
String![Greenhouse](https://merge-api-production.s3.amazonaws.com/media/Greenhouse_Square_Logo.jpg)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
Stringsubject
Stringuser
UUIDvisibility
Enum![Infinite BrassRing](https://merge-api-production.s3.amazonaws.com/media/Infinite_square_oo6UcJ3.png)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
String![JobAdder](https://merge-api-production.s3.amazonaws.com/media/Platformjobadder_square.png)
Supported POST Model Parameters
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringuser
UUIDAdditional POST Parameters
integration_params
Objectcandidate_merge_id
String![Lever](https://merge-api-production.s3.amazonaws.com/media/Lever_Square_Logo_oYg8yBW.jpg)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
StringAdditional POST Parameters
integration_params
Objectcandidate_id
Stringcandidate_merge_id
String![SAP SuccessFactors](https://merge-api-production.s3.amazonaws.com/media/SuccessFactors_Square_Logo_BcXogF0.jpg)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_id
String![UKG Pro Recruiting](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_zTMYILE.png)
Supported POST Model Parameters
body
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
Stringuser
UUIDhttps://api.merge.dev/api/ats/v1/activities/{id}
Returns an Activity
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String![ApplicantStack](https://merge-api-production.s3.amazonaws.com/media/ApplicantStack_Square_Logo_wBHYVRL.jpg)
Supported Response Fields
activity_type
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsubject
Stringuser
UUID![Ashby](https://merge-api-production.s3.amazonaws.com/media/Ashby_Square_Logo_3uQWavw.png)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringuser
UUID![CATS](https://merge-api-production.s3.amazonaws.com/media/CATS_Square_Logo_J4NkqoE.jpg)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUID![Fountain](https://merge-api-production.s3.amazonaws.com/media/Fountain_Square_Logo.png)
Supported Response Fields
activity_type
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUID![Greenhouse](https://merge-api-production.s3.amazonaws.com/media/Greenhouse_Square_Logo.jpg)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUIDvisibility
Enum![Homerun](https://merge-api-production.s3.amazonaws.com/media/homerun.png)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsubject
Stringvisibility
Enum![JazzHR](https://merge-api-production.s3.amazonaws.com/media/JazzHR_Square_Logo_WQcMDMd.jpg)
Supported Response Fields
activity_type
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUID![JobScore](https://merge-api-production.s3.amazonaws.com/media/JobScore-square.png)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringuser
UUIDvisibility
Enum![Lever](https://merge-api-production.s3.amazonaws.com/media/Lever_Square_Logo_oYg8yBW.jpg)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUIDvisibility
Enum![Sage HR](https://merge-api-production.s3.amazonaws.com/media/Sage_Square_Logo_FAQpKpP.jpg)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsubject
String![SAP SuccessFactors](https://merge-api-production.s3.amazonaws.com/media/SuccessFactors_Square_Logo_BcXogF0.jpg)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringuser
UUID![Teamtailor](https://merge-api-production.s3.amazonaws.com/media/Teamtailor_Square_Logo.jpg)
Supported Response Fields
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
Stringuser
UUID![UKG Pro Recruiting](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_zTMYILE.png)
Supported Response Fields
body
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringuser
UUID![Workable](https://merge-api-production.s3.amazonaws.com/media/Workable_Square_Logo_OvllNl9.jpg)
Supported Response Fields
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsubject
Stringuser
UUIDhttps://api.merge.dev/api/ats/v1/activities/meta/post
Returns metadata for Activity
POSTs.
![Ashby](https://merge-api-production.s3.amazonaws.com/media/Ashby_Square_Logo_3uQWavw.png)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
Stringuser
UUIDAdditional POST Parameters
integration_params
Objectcandidate_merge_id
String![Greenhouse](https://merge-api-production.s3.amazonaws.com/media/Greenhouse_Square_Logo.jpg)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
Stringsubject
Stringuser
UUIDvisibility
Enum![Infinite BrassRing](https://merge-api-production.s3.amazonaws.com/media/Infinite_square_oo6UcJ3.png)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
String![JobAdder](https://merge-api-production.s3.amazonaws.com/media/Platformjobadder_square.png)
Supported POST Model Parameters
activity_type
Enumbody
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringuser
UUIDAdditional POST Parameters
integration_params
Objectcandidate_merge_id
String![Lever](https://merge-api-production.s3.amazonaws.com/media/Lever_Square_Logo_oYg8yBW.jpg)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
StringAdditional POST Parameters
integration_params
Objectcandidate_id
Stringcandidate_merge_id
String![SAP SuccessFactors](https://merge-api-production.s3.amazonaws.com/media/SuccessFactors_Square_Logo_BcXogF0.jpg)
Supported POST Model Parameters
activity_type
Enumbody
Stringcandidate
UUIDremote_id
String![UKG Pro Recruiting](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_zTMYILE.png)
Supported POST Model Parameters
body
Stringcandidate
UUIDremote_created_at
DateTime (ISO 8601)remote_id
Stringuser
UUID