Rolefy

Documentation

Rolefy API

REST API for connecting your HR or recruitment system to Rolefy: push jobs to Rolefy, collect the applications candidates submit, and subscribe to events through webhooks.

Base URL

https://developer.rolefy.fit/api

Version

v1.0

Format

JSON over HTTPS

OpenAPI spec

Quick start

  1. 1

    Create a developer account

    Sign up with your email — it takes a minute.

    Create an account
  2. 2

    Apply for API credentials

    Tell us what you're building and which scopes you need. We review it, then email your client ID and secret once.

    New application
  3. 3

    Get an access token

    Trade your credentials for a token that lasts one hour.

    curl
    curl -X POST "https://developer.rolefy.fit/api/v1/oauth/token" \
  -H "Content-Type: application/json" \
  -d '{ "client_id": "your-client-id", "client_secret": "your-client-secret" }'
  4. 4

    Call the API

    Send the token as a bearer token on every request.

    curl
    curl "https://developer.rolefy.fit/api/v1/jobs?limit=5" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Guides

Getting credentialsHow applications are reviewed, and when your client ID and secret arrive. AuthenticationExchange your credentials for a one-hour access token. Sandbox and liveTest safely first. Sandbox jobs never reach the public job board. Employer scopingWhy every request only ever sees one employer's jobs and applications. Pushing jobs safelyCreate or update a job by your own id, so a retry never duplicates it. PaginationThe limit and offset parameters every list endpoint takes. ErrorsThe error format, and every code you can expect to see. Rate limitsHow many requests you can make, and what a 429 means. WebhooksReceive signed events for applications and job status changes. Many employersHow a platform that serves many employers is set up.

API reference

All endpoints

Authentication

Exchange your application's credentials for a short-lived access token.

Jobs

Create and update your jobs, and close them.

Job categories

The job categories Rolefy uses, so you can label your jobs the way candidates search for them.

Applications

The applications candidates submit to your jobs.

Webhooks

Subscribe to events and have Rolefy deliver them to your own endpoint.