Merge ATS - Activities

Activities

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

The Activity object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

userString

Optional

The user that performed the action.

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.

candidateString

Optional

The activity’s candidate.

remote_was_deletedBoolean

Required

Indicates whether or not this object has been deleted by third party webhooks.

field_mappingsObject

Optional

modified_atString

Required

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

remote_dataRemoteData[]

Optional

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",
  "candidate": "03455bc6-6040-430a-848e-aafacbfdf4fg",
  "remote_was_deleted": true,
Show advanced fields
}

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 marked as deleted by third party webhooks.

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, only objects synced by Merge after this date time will be returned.

modified_beforeString

Optional

If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger

Optional

Number of results to return per page.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

remote_idString

Optional

The API provider's ID for the given object.

show_enum_originsString

Optional

Which fields should be returned in non-normalized form.

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",
      "candidate": "03455bc6-6040-430a-848e-aafacbfdf4fg",
      "remote_was_deleted": true,
Show advanced fields
    }
  ]
}

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

visibilityEnum

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

visibilityEnum

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

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

POST

/activities

Beta

Creates an Activity object with the given values.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

Whether or not third-party updates should be run asynchronously.

Body Parameters

modelObject

Required

Find available fields below under “Model Parameters”.

remote_user_idString

Required

Model Parameters

View app-specific writable fields under “Field support by platform” in this section.

userString

The 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_typeEnum

The activity's type. Must pass in one of the following choices: NOTE, EMAIL, OTHER.

subjectString

The activity's subject.

bodyString

The activity's body.

visibilityEnum

The activity's visibility. Must pass in one of the following choices: ADMIN_ONLY, PUBLIC, PRIVATE.

candidateString

The activity’s candidate.

integration_paramsObject

linked_account_paramsObject

POST v1/activities

JSON


{
  "model": {
    "user": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
    "activity_type": "NOTE",
    "subject": "Gil Feig's interview",
    "body": "Candidate loves integrations!!.",
    "visibility": "PRIVATE",
    "candidate": "03455bc6-6040-430a-848e-aafacbfdf4fg"
  },
  "remote_user_id": "string"
}

Response

JSON


{
  "model": {
    "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",
    "candidate": "03455bc6-6040-430a-848e-aafacbfdf4fg",
    "remote_was_deleted": true,
Show advanced fields
  }
}

Ashby

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

activity_typeEnum

Optional

bodyString

Required

remote_created_atString

Optional

remote_idString

Optional

userString

Optional

Additional POST Parameters

integration_paramsObject

Required

candidate_merge_idString

Required

JobAdder

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

activity_typeEnum

Optional

bodyString

Required

remote_created_atString

Optional

remote_idString

Optional

userString

Optional

Additional POST Parameters

integration_paramsObject

Required

candidate_merge_idString

Required

Lever

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

activity_typeEnum

Optional

bodyString

Required

remote_created_atString

Optional

remote_idString

Optional

Additional POST Parameters

integration_paramsObject

Required

candidate_idString

Required

candidate_merge_idString

Required

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.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

show_enum_originsString

Optional

Which fields should be returned in non-normalized form.

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",
  "candidate": "03455bc6-6040-430a-848e-aafacbfdf4fg",
  "remote_was_deleted": true,
Show advanced fields
}

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

visibilityEnum

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

visibilityEnum

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

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

GET

/activities/meta/post

Returns metadata for Activity POSTs.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Response

JSON


{
  "request_schema": {},
  "remote_field_classes": {},
  "status": {
    "linked_account_status": "string",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

visibilityEnum

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

visibilityEnum

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

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

Overview

Next Up

Get Started

API Reference

Previous

Next Up