Skip to main content
This guide walks you through making your first API request to retrieve data from a linked account.

​
Prerequisites

  1. API Key created in StackOne Dashboard and copied to a secure location
  2. Basic Authentication Setup - Learn how to properly authenticate with StackOne API using your API key
  3. Required provider integration enabled
  4. Account linked successfully
  5. (Optional) Use an SDK or Postman

​
Getting Account ID

Authentication: When using curl -u "$API_KEY:", encoding is handled automatically. When setting the Authorization header manually, you must base64 encode your API key first. See the Basic Authentication Guide for details.
  1. List your linked accounts to find the account ID:
curl --request GET \
     --url https://api.stackone.com/accounts \
     --header 'accept: application/json' \
     --header 'authorization: Basic {base64_encoded_api_key}'
  1. From the response, copy the id value for your desired provider account.
Filter by provider using the providers query parameter:
curl --request GET \
     --url 'https://api.stackone.com/accounts?providers={provider_name}' \
     --header 'accept: application/json' \
     --header 'authorization: Basic {base64_encoded_api_key}'

​
Making Your First Request

Now you’re ready to make your first ATS API call. Let’s list candidates from the connected applicant tracking system: 
curl --request GET \
  --url 'https://api.stackone.com/unified/ats/candidates' \
  --header 'accept: application/json' \
  --header 'authorization: Basic {base64_encoded_api_key}' \
  --header 'x-account-id: {account_id}'

​
Example Response

{
  "data": [
    {
      "id": "cand_123",
      "remote_id": "abc123",
      "first_name": "Alex",
      "last_name": "Johnson",
      "name": "Alex Johnson",
      "email": "[email protected]",
      "phone_number": "+1-555-0123",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ]
}

​
Next Steps

Get Candidate

Retrieve details for a specific candidate

List Jobs

Get open positions from the ATS

Pagination

Handle large result sets efficiently

Applications

View candidate applications

​
References