Merge Docs

Available Actions

The available actions endpoint lets you ask "For this given customer’s choice of platform, what functionality am I able to take advantage of?"

Overview

Available actions returns a list of models and actions available for an account with:

  • integration: Includes name, categories, image, square image, and primary color. Using this information, you can display a custom UI that accurately reflects the integration your user has chosen to link.
  • passthrough_available: This is almost always true, and it defines whether you are able to use the Passthrough endpoint to make custom requests of any kind to the given API.
  • available_model_operations: For the provided integration, we return each supported data model, the supported operations (FETCH/CREATE/UPDATE/DELETE), the supported fields, and the required fields to create an instance of that model.

Request

In the URL below, replace ats with the integration category you would want a list of models and actions available for - use hris, ats, or accounting.

You will also want to include an Authorization header that includes your Merge API key - see the Authentication section for more details.

GET https://api.merge.dev/api/ats/v1/available-actions

Headers


X-Account-TokenString
Required
Token identifying the end user's Linked Account from Merge Link.

Response

Example Available Actions Response

{
  "integration": {
    "name": "Lever",
    "categories": [
      "ats"
    ],
    "image": "https://merge-api-production.s3.amazonaws.com/media/Lever_Logo.png",
    "square_image": "https://merge-api-production.s3.amazonaws.com/media/Lever_Square_Logo.png",
    "color": "#262A34"
  },
  "passthrough_available": true,
  "available_model_operations": [
    {
      "model_name": "Candidate",
      "available_operations": [
        "FETCH",
        "CREATE"
      ],
      "required_post_parameters": [
        "remote_user_id"
      ],
      "supported_fields": [
        "first_name",
        "last_name",
        "company",
        "title"
      ]
    }
  ]
}