ayhire-com

ayhire-com Roles API

Open positions: their criteria, their searches, the people in them and your decisions.

GitHub OpenAPI

Operations 38

GET /api/imports/{id} An import, its counts and its rows #
POST /api/imports/{id}/cancel Stop an import #
GET /api/imports/{id}/export Every row of an import as CSV #
POST /api/imports/{id}/rows/{row} Say who a row to check is #
POST /api/imports/{id}/run Confirm an import, then run it one step at a time #
GET /api/roles Your roles, newest first #
POST /api/roles Add a role #
POST /api/roles/parse Read a sentence into a role's title and search #
GET /api/roles/people Everyone in the workspace's roles #
GET /api/roles/{id} A role and its people, ranked #
PATCH /api/roles/{id} Change a role's title, brief or search #
DELETE /api/roles/{id} Delete a role with its people and activity #
GET /api/roles/{id}/ats-job The ATS job this role's shortlist goes to #
PUT /api/roles/{id}/ats-job Choose the ATS job for this role #
PUT /api/roles/{id}/criteria Replace what a role needs #
POST /api/roles/{id}/criteria/suggest Suggest criteria from the role's title and brief #
GET /api/roles/{id}/funnel The role's hiring funnel #
GET /api/roles/{id}/imports The role's last 5 imports #
POST /api/roles/{id}/imports Import a list of people into the role (a preview first) #
PATCH /api/roles/{id}/linkedin/{alias} Decide on someone the role found on LinkedIn #
POST /api/roles/{id}/linkedin/{alias}/ats Send someone found on LinkedIn to the workspace's ATS #
POST /api/roles/{id}/people Add people to a role #
PATCH /api/roles/{id}/people/{username} Save a decision, watch, contacted date, notes or Not now reasons #
POST /api/roles/{id}/people/{username}/ats Send this person to the workspace's ATS #
GET /api/roles/{id}/people/{username}/brief An interview brief for one person in the role #
POST /api/roles/{id}/people/{username}/check Check someone's availability again now #
GET /api/roles/{id}/people/{username}/outcomes One person's hiring outcomes in the role #
POST /api/roles/{id}/people/{username}/outcomes Record a hiring outcome #
DELETE /api/roles/{id}/people/{username}/outcomes/{event} Remove a hiring outcome #
POST /api/roles/{id}/people/{username}/score Score one person for the role #
GET /api/roles/{id}/plan A role's search plan, what you set on top, and what the next round changes #
POST /api/roles/{id}/plan Read the role's search plan again #
PUT /api/roles/{id}/plan Change a role's search plan as a new version #
GET /api/roles/{id}/rounds A role's search rounds, newest first #
POST /api/roles/{id}/rounds Run the role's next search round #
POST /api/roles/{id}/run Search, save and score in one call #
POST /api/roles/{id}/search Find new people for a role #
GET /api/shortlist Everyone you shortlisted, across roles #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ayhire-com/openapi/ayhire-com-roles-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-repository-knowledge-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-role-funnel-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-outcome-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-scraped-candidate-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-role-person-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-watch-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ayhire-com:ayhire-com-roles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ayhire-com-roles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ayhire Com Roles API
  version: 1.0.0
  contact:
    name: AyHire
    url: https://ayhire.com
  description: 'Operations tagged Roles across 2 of this provider''s published API definitions: ayhire-com-openapi.json, ayhire-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ayhire.com
security:
- bearerAuth: []
- apiKeyHeader: []
tags:


# --- truncated at 32 KB (167 KB total) ---
# Full source: https://artifacts.apis.io/ayhire-com/openapi/ayhire-com-roles-api-openapi.yml