GET

/linked-accounts

List linked accounts for your organization.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

Query & Path Parameters


categoryString
Optional

cursorString
Optional
The pagination cursor value.

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

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

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

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

idString
Optional

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

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

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

page_sizeInteger
Optional
Number of results to return per page.

statusString
Optional
Filter by status. Options: COMPLETE, INCOMPLETE, RELINK_NEEDED

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "e59b1821-f85c-4e28-a6b3-1804156f3563",
"category": "hris",
"status": "COMPLETE",
"status_detail": "string",
"end_user_origin_id": "3ac95cde-6c7f-4eef-afec-be710b42308d",
"end_user_organization_name": "Foo Bar, LLC",
"end_user_email_address": "[email protected]",
"webhook_listener_url": "https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4",
"integration": {
"name": "SAP SuccessFactors",
"categories": [
"hris",
"ats"
],
"image": "https://cdn.merge.dev/SuccessFactors_Logo.png",
"square_image": "https://cdn.merge.dev/SuccessFactors_Square_Logo.jpg",
"color": "#F6A704",
"slug": "sap-successfactors",
"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"
]
}
]
}
}
]
}