Aram REST API

Build powerful hiring integrations. Push JDs from your ATS, pull AI match results into your HRIS, or build custom dashboards — all with a single API key.

Base URL

https://api.scootsign.com/api/v1

All requests require the X-API-Key header. Get your API key →

Quick Start

curl https://api.scootsign.com/api/v1/whoami \
  -H "X-API-Key: aram_ent_a1b2c3d4e5f6..."

Response Format

All responses follow a consistent envelope:

Tip: Every list endpoint returns pagination with page, limit, total, and pages.

{
  "success": true,
  "data": { ... },
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "pages": 3
  }
}

Error responses always include a human-readable message:

{
  "success": false,
  "error": "API key does not have the required scope: jds:write"
}

Available Endpoints

Code Examples

JavaScript / Node.js

const response = await fetch("https://api.scootsign.com/api/v1/jds", {
  headers: { "X-API-Key": process.env.ARAM_API_KEY },
});
const { data, pagination } = await response.json();
console.log(`Found ${pagination.total} job descriptions`);

Python

import requests, os

resp = requests.get(
    "https://api.scootsign.com/api/v1/jds",
    headers={"X-API-Key": os.environ["ARAM_API_KEY"]},
)
data = resp.json()["data"]
print(f"Found {resp.json()['pagination']['total']} JDs")

cURL

curl -s https://api.scootsign.com/api/v1/jds \
  -H "X-API-Key: aram_ent_a1b2c3d4e5f6..." | jq '.data'

Need Help?