Merge API Documentation

curl -X POST https://api.merge.dev/api/ats/v1/interviews \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": {},
  "remote_user_id": "string"
}'

{
  "model": {
    "id": "b8faf072-98b9-4445-8a9a-6b4950efca19",
    "remote_id": "3",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "application": "92e8a369-fffe-430d-b93a-f7e8a16563f1",
    "job_interview_stage": "2f7adb59-3fe6-4b5b-aef6-563f72bd13dc",
    "organizer": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
    "interviewers": [
      "f9813dd5-e70b-484c-91d8-00acd6065b07",
      "89a86fcf-d540-4e6b-ac3d-ce07c4ec9b3c"
    ],
    "location": "Embarcadero Center 2",
    "start_at": "2021-10-15T00:00:00Z",
    "end_at": "2021-10-15T02:00:00Z",
    "remote_created_at": "2021-10-15T00:00:00Z",
    "remote_updated_at": "2021-10-15T00:00:00Z",
    "status": "SCHEDULED",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/interviews"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true,
      "raw_error": "string",
      "error_code": 1
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true,
      "raw_error": "string",
      "error_code": 1
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates a ScheduledInterview object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query 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.

Request

This endpoint expects an object.

modelobjectRequired

Description

The ScheduledInterview object is used to represent a scheduled interview for a given candidate’s application to a job. An Application can have multiple ScheduledInterviews depending on the particular hiring process.

Usage Example

Fetch from the LIST ScheduledInterviews endpoint and filter by interviewers to show all office locations.

remote_user_idstringRequired

Response

modelobject

Description

Usage Example

Fetch from the LIST ScheduledInterviews endpoint and filter by interviewers to show all office locations.

warningslist of objects

errorslist of objects

logslist of objects

/interviews

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration