WarmablyWarmablyDOCS
Search docs⌘K
Dashboard
API Reference/Endpoints

List available contracts

GET/api/linkedin/gateway/linkedin/contracts

Lists the Recruiter and Sales Navigator contracts this account can act under, and which one is currently active. Some organizations put a single seat on more than one contract — use Select a contract to switch.

Authentication

Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401.

Query parameters

FieldTypeDescription
account_id *stringA connected account's id.

Response fields

FieldTypeDescription
object"ContractList"Always this value.
items[].product"recruiter" | "sales_navigator"Which product this contract is for.
items[].selectedbooleanWhether this is the contract currently active on the account.
items[].name / descriptionstringHow the contract is labeled in LinkedIn.

Errors

·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. The account_id doesn't belong to this key, or the account has no Recruiter/Sales Navigator contracts at all.
CredentialsRequired
AuthorizationBearer wm_live_••••••••
RequestTry it
curl "https://api.warmably.com/api/linkedin/gateway/linkedin/contracts?account_id=459993d2-b0e7-4b19-baf9-45252ca324cf" \
  -H "Authorization: Bearer wm_live_..."
Response
200 OK
{
  "object": "ContractList",
  "items": [
    {
      "product": "recruiter",
      "selected": true,
      "id": "c88b2e5b-2f39-4c9a-9d61-6a3f8e21a9dd",
      "name": "Acme Corp — Recruiter Corporate",
      "description": "Company-wide Recruiter seat"
    },
    {
      "product": "sales_navigator",
      "selected": false,
      "id": "9a7c1d4e-8b52-4a10-b6f3-1e2d3c4b5a69",
      "name": "Acme Corp — Sales Navigator Team"
    }
  ]
}
No key yet? Create one from Dashboard → API Keys.