Documentation

Overview

Query our data with natural-language queries — e.g. "senior Python developers with Kubernetes in Seattle" — and fetch full detail on any result by its profile id.

The Ask Xverum API is a stateless, resource-oriented API under /v1, authenticated with an x-api-key header. Search for people, then get any profile directly — no session handles, no server-side result-set state.

Get started

  1. Quickstart — make your first call in 60 seconds.
  2. Authentication — how x-api-key works, the error envelope, and how to get a key.
  3. Rate limits — quotas, quota headers, and the Retry-After header.

Reference

EndpointPurpose
POST /v1/searchRun a natural-language people search
GET /v1/profiles/{id}Get a single profile by id

OpenAPI

The live OpenAPI 3.1 schema is served by the API at:

https://search-api.xverum.com/openapi.json

Endpoints are tagged v1, and the x-api-key scheme is declared as an apiKey-in-header security scheme. Import it into Postman, Insomnia, or any OpenAPI-compatible tool to generate clients in your language of choice.