People API

The People API gives each workspace a programmatic way to inspect configured people data sources, resolve Arxena taxonomy values, and search people with a workspace-scoped Bearer token.

Authentication

Every People API request except the raw OpenAPI document requires a workspace token:

Authorization: Bearer YOUR_API_KEY_TOKEN

Create a token

Go to Settings → APIs & Webhooks
Click + Create key
Save the key and copy it immediately
Use the generated token as your Bearer credential

For production use, assign the API key to a role under Settings → Members → Roles → Assignment so the key only gets the permissions it needs.

Keep this token secret. Anyone who has it can call the People API with your workspace permissions.

Base URL

Use your workspace host as the base URL:

https://{your-domain}

Examples below assume https://app.arxena.com.

What is public

The OpenAPI document is public:

curl https://app.arxena.com/people-api/openapi.json

All other People API endpoints require Authorization: Bearer ....

Check what is enabled

People search providers are only available when the corresponding backend services are configured. Before integrating, call GET /people-api/data-sources to see which aliases are enabled in your workspace environment.

curl -H 'Authorization: Bearer YOUR_API_KEY_TOKEN' \
  https://app.arxena.com/people-api/data-sources

Example response:

{
  "status": "ok",
  "sources": [
    {
      "alias": "index",
      "label": "People Index",
      "description": "Search the internal people index.",
      "supportsStdFunctionFilter": true,
      "supportsStdGradeFilter": true,
      "configured": true
    }
  ]
}

Taxonomy endpoints

Use these endpoints to inspect or resolve standardized taxonomy values before running a people search.

Function roots

curl -H 'Authorization: Bearer YOUR_API_KEY_TOKEN' \
  'https://app.arxena.com/people-api/taxonomy/function-roots'

You can also classify a title:

curl -H 'Authorization: Bearer YOUR_API_KEY_TOKEN' \
  'https://app.arxena.com/people-api/taxonomy/function-roots?title=VP%20Engineering'

Functions

curl -H 'Authorization: Bearer YOUR_API_KEY_TOKEN' \
  'https://app.arxena.com/people-api/taxonomy/functions?function_root=engineering'

Grades

curl -H 'Authorization: Bearer YOUR_API_KEY_TOKEN' \
  'https://app.arxena.com/people-api/taxonomy/grades?grade_level=leadership'

Boolean strings from taxonomy

Use this when you want a keyword-oriented Boolean query built from standardized taxonomy fields.

curl -H 'Authorization: Bearer YOUR_API_KEY_TOKEN' \
  'https://app.arxena.com/people-api/taxonomy/boolean-strings?std_function=engineering&std_grade=leadership&company_name=Stripe'

Expand a job title

Use this to normalize a raw title and generate a keyword query.

curl -H 'Authorization: Bearer YOUR_API_KEY_TOKEN' \
  'https://app.arxena.com/people-api/titles/expand?job_title=Head%20of%20Product&company_name=Stripe'

Search endpoints

Search by resolved title

POST /people-api/people/search-by-title classifies the input title into stdFunction and stdGrade, then performs the people search.

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_KEY_TOKEN' \
  -H 'Content-Type: application/json' \
  https://app.arxena.com/people-api/people/search-by-title \
  -d '{
    "jobTitle": "Head of Engineering",
    "companyName": "Stripe",
    "dataSource": "index",
    "limit": 10
  }'

Use this when you have a natural-language title and want Arxena to resolve the taxonomy fields for you.

Search directly

POST /people-api/people/search searches by standardized filters or provider-specific fields.

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_KEY_TOKEN' \
  -H 'Content-Type: application/json' \
  https://app.arxena.com/people-api/people/search \
  -d '{
    "dataSource": "index",
    "companyName": "Stripe",
    "stdFunction": "engineering",
    "stdGrade": "leadership",
    "country": "United States",
    "limit": 20,
    "offset": 0
  }'

Data source notes

The API exposes provider aliases instead of vendor-specific routing logic:

Alias	Typical use
`index`	Search Arxena’s internal people index with taxonomy filters
`apollo`	Search via Apollo when configured
`contactout`	Search via ContactOut when configured
`harvest`	Search via Harvest when configured
`pdl`	Reserved alias; not currently exposed by the public search endpoint

If a provider is not enabled, the API returns 503 Service Unavailable. If an alias is recognized but not yet supported for that endpoint, it returns 501 Not Implemented.

OpenAPI and playground usage

Raw OpenAPI document: GET /people-api/openapi.json
In-app REST playground: available in Settings → APIs & Webhooks

The REST playground uses the same workspace token flow, so the People API appears there once the server exposes the merged core OpenAPI schema.

Overview

Apps

API

Self-Host

Contribute

Authentication

Create a token

Base URL

What is public

Check what is enabled

Taxonomy endpoints

Function roots

Functions

Grades

Boolean strings from taxonomy

Expand a job title

Search endpoints

Search by resolved title

Search directly

Data source notes

OpenAPI and playground usage

​Authentication

​Create a token

​Base URL

​What is public

​Check what is enabled

​Taxonomy endpoints

​Function roots

​Functions

​Grades

​Boolean strings from taxonomy

​Expand a job title

​Search endpoints

​Search by resolved title

​Search directly

​Data source notes

​OpenAPI and playground usage

Authentication

Create a token

Base URL

What is public

Check what is enabled

Taxonomy endpoints

Function roots

Functions

Grades

Boolean strings from taxonomy

Expand a job title

Search endpoints

Search by resolved title

Search directly

Data source notes

OpenAPI and playground usage