Connect an ATS

POST
/ats/connections

Creates a pending connection and returns a hosted connect link. An admin opens the URL and completes credentials on the provider's own screen; no ATS credential passes through this API. Requires ats:write and a live client-admin role.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from Settings > API access, sent as Authorization: Bearer sp_live_.... Send exactly one credential per request; a request carrying both a bearer token and a session cookie is rejected rather than resolved by precedence.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/ats/connections" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "status": "string",  "magicLinkUrl": "string",  "expiresAt": "2019-08-24T14:15:22Z"}

Last updated on