# ayhire-com Roles API

**Canonical:** https://apis.io/apis/ayhire-com/ayhire-com-roles-api/  
**Provider:** ayhire-com — https://apis.io/providers/ayhire-com/  
**Base URL:** https://ayhire.com  
**Documentation:** https://ayhire.com/api/docs

ayhire-com Roles API is one of 8 APIs that [ayhire-com](https://apis.io/providers/ayhire-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

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

## Operations (38)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/ayhire-com/openapi/ayhire-com-roles-api-openapi.yml
- **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

## Other ayhire-com APIs (7)

- [ayhire-com Account API](https://apis.io/apis/ayhire-com/ayhire-com-account-api/)
- [ayhire-com Company maps API](https://apis.io/apis/ayhire-com/ayhire-com-company-maps-api/)
- [ayhire-com Integrations API](https://apis.io/apis/ayhire-com/ayhire-com-integrations-api/)
- [ayhire-com People API](https://apis.io/apis/ayhire-com/ayhire-com-people-api/)
- [ayhire-com Research API](https://apis.io/apis/ayhire-com/ayhire-com-research-api/)
- [ayhire-com Watching API](https://apis.io/apis/ayhire-com/ayhire-com-watching-api/)
- [ayhire-com Workspaces API](https://apis.io/apis/ayhire-com/ayhire-com-workspaces-api/)

## Tags

Roles

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ayhire-com/ayhire-com-roles-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ayhire-com/.