Making your first request

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

Prerequisites

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

Getting Account ID

Authentication: When using curl -u "$API_KEY:", encoding is handled automatically. When setting the Authorization header manually, base64 encode {api_key}:, your key followed by a colon. See Authentication for details.

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}'

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}'

Now you’re ready to make your first ATS API call. Let’s list candidates from the connected applicant tracking system:

cURL
TypeScript
Python

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}'

import { StackOne } from "@stackone/stackone-client-ts";

const client = new StackOne({ apiKey: "YOUR_API_KEY" });

const response = await client.ats.listCandidates({
  xAccountId: "your-account-id"
});

console.log(response.candidates);

from stackone_client import StackOne

client = StackOne(api_key="YOUR_API_KEY")

response = client.ats.list_candidates(
    x_account_id="your-account-id"
)

print(response.candidates)

Example Response

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

API Reference

Making your first request

Prerequisites

Getting Account ID