For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
  • Authentication
    • Merge Link
    • Prompt guide for Merge Link
    • Magic Link
    • Single integration
  • Reading data
    • Syncing best practices
  • Supplemental data
    • Overview
    • Remote Data
    • Custom objects
  • Writing data
    • Overview
  • Platform and account metadata
    • Integration metadata
    • Linked Accounts
  • Testing
    • Testing Merge's Unified API via Postman
  • Specifications
    • Schema properties
    • Model Context Protocol (MCP)
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
On this page
  • Overview
  • Request
Platform and account metadata

Linked Accounts

The Linked Accounts endpoint lets you ask “For this given customer’s choice of platform, what functionality am I able to take advantage of?”

Was this page helpful?
Previous

Integration Metadata

Next

Testing Merge's Unified API via Postman

Built with

Overview

The Linked Accounts endpoint returns a list of LinkedAccount objects. Each LinkedAccount contains, among other things, the following information about the models and actions available for that account:

  • integration: Includes name, categories, image, square image, and primary color. You can use this information to build an adaptive UI that accurately reflects the integration your user has chosen to link.
  • passthrough_available: defines whether you are able to use the Passthrough endpoint to make custom requests of any kind to the given API. This value is almost always true.
  • 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

The request will return all linked accounts regardless of which category is passed into the URL.

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/linked-accounts

Example Linked Accounts response
1{
2 "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3 "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4 "results": [
5 {
6 "id": "e59b1821-f85c-4e28-a6b3-1804156f3563",
7 "category": "hris",
8 "status": "INCOMPLETE",
9 "status_detail": "Invalid login credentials",
10 "end_user_origin_id": "3ac95cde-6c7f-4eef-afec-be710b42308d",
11 "end_user_organization_name": "Foo Bar, LLC",
12 "end_user_email_address": "hradmin@foobar.dev",
13 "subdomain": "foobar",
14 "webhook_listener_url": "https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4",
15 "is_duplicate": true,
16 "integration": {
17 "name": "SAP SuccessFactors",
18 "categories": [
19 "hris",
20 "ats"
21 ],
22 "image": "https://cdn.merge.dev/SuccessFactors_Logo.png",
23 "square_image": "https://cdn.merge.dev/SuccessFactors_Square_Logo.jpg",
24 "color": "#F6A704",
25 "slug": "sap-successfactors",
26 "passthrough_available": true,
27 "available_model_operations": [
28 {
29 "model_name": "Candidate",
30 "available_operations": [
31 "FETCH",
32 "CREATE"
33 ],
34 "required_post_parameters": [
35 "remote_user_id"
36 ],
37 "supported_fields": [
38 "first_name",
39 "last_name",
40 "company",
41 "title"
42 ]
43 }
44 ]
45 },
46 "account_type": "PRODUCTION",
47 "completed_at": "2024-08-26T20:11:19.277118Z",
48 "integration_specific_fields": {
49 "integration_specific_field": "Varies by platform"
50 }
51 }
52 ]
53}