/linked-accounts

curl -G https://api.merge.dev/api/knowledgebase/v1/linked-accounts \
     -H "Authorization: Bearer <token>" \
     -d cursor=cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "e59b1821-f85c-4e28-a6b3-1804156f3563",
      "status": "INCOMPLETE",
      "end_user_organization_name": "Foo Bar, LLC",
      "end_user_email_address": "hradmin@foobar.dev",
      "webhook_listener_url": "https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4",
      "account_type": "PRODUCTION",
      "completed_at": "2024-08-26T20:11:19.277118Z",
      "category": "hris",
      "status_detail": "Invalid login credentials",
      "end_user_origin_id": "3ac95cde-6c7f-4eef-afec-be710b42308d",
      "subdomain": "foobar",
      "is_duplicate": true,
      "integration": {
        "name": "SAP SuccessFactors",
        "categories": [
          "hris",
          "ats"
        ],
        "color": "#F6A704",
        "slug": "sap-successfactors",
        "passthrough_available": true,
        "image": "https://cdn.merge.dev/SuccessFactors_Logo.png",
        "square_image": "https://cdn.merge.dev/SuccessFactors_Square_Logo.jpg",
        "available_model_operations": [
          {
            "model_name": "Candidate",
            "available_operations": [
              "FETCH",
              "CREATE"
            ],
            "required_post_parameters": [
              "remote_user_id"
            ],
            "supported_fields": [
              "first_name",
              "last_name",
              "company",
              "title"
            ]
          }
        ]
      },
      "integration_specific_fields": {
        "integration_specific_field": "Varies by platform"
      }
    }
  ]
}

List linked accounts for your organization.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

categoryenumOptional

Options: accounting, ats, crm, filestorage, hris, knowledgebase, mktg, ticketing

hris - hris
ats - ats
accounting - accounting
ticketing - ticketing
crm - crm
mktg - mktg
filestorage - filestorage
datawarehouse - datawarehouse
knowledgebase - knowledgebase
communication - communication
chat - chat

Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing` * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage * `datawarehouse` - datawarehouse * `knowledgebase` - knowledgebase * `communication` - communication * `chat` - chat

cursorstringOptional

The pagination cursor value.

end_user_email_addressstringOptional

If provided, will only return linked accounts associated with the given email address.

end_user_organization_namestringOptional

If provided, will only return linked accounts associated with the given organization name.

end_user_origin_idstringOptional

If provided, will only return linked accounts associated with the given origin ID.

end_user_origin_idsstringOptional

Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.

idstringOptionalformat: "uuid"

idsstringOptional

Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.

include_duplicatesbooleanOptional

If true, will include complete production duplicates of the account specified by the id query parameter in the response. id must be for a complete production linked account.

integration_namestringOptional

If provided, will only return linked accounts associated with the given integration name.

is_test_accountstringOptional

If included, will only include test linked accounts. If not included, will only include non-test linked accounts.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

statusstringOptional

Filter by status. Options: COMPLETE, IDLE, INCOMPLETE, RELINK_NEEDED

Response

nextstring or null

previousstring or null

resultslist of objects or null