Rune HR - API documentation

applications

DELETE /applications/:id

GET /applications/:id

id text primary-key
job text required
talent text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"job": "value",
"talent": "value"
}

POST /applications

id text primary-key
job text required
talent text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"job": "value",
"talent": "value"
}

GET /applications

id text primary-key
job text required
talent text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"job": "value",
"talent": "value"
}

applications-stages

DELETE /applications_stages/:id

POST /applications_stages

id text primary-key
application text required
stage text required
status text required
begins_at date
ends_at date

    {
"id": "00000000-0000-0000-0000-000000000000", 
"application": "value",
"stage": "value",
"status": "value",
"begins_at": "2024-04-29",
"ends_at": "2024-04-29"
}

companies

DELETE /companies/:id

PATCH /companies/:id

linkedin text
logo text
location text
name text required
organization text required
size text
website text

    {
"linkedin": "value", 
"logo": "value",
"location": "value",
"name": "value",
"organization": "value",
"size": "value",
"website": "value"
}

GET /companies/:id

id text primary-key
linkedin text
logo text
name text required
size text
website text
location text
organization text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"linkedin": "value",
"logo": "value",
"name": "value",
"size": "value",
"website": "value",
"location": "value",
"organization": "value"
}

POST /companies

linkedin text
logo text
location text
name text required
organization text required
size text
website text

    {
"linkedin": "value", 
"logo": "value",
"location": "value",
"name": "value",
"organization": "value",
"size": "value",
"website": "value"
}

GET /companies

id text primary-key
linkedin text
logo text
name text required
size text
website text
location text
organization text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"linkedin": "value",
"logo": "value",
"name": "value",
"size": "value",
"website": "value",
"location": "value",
"organization": "value"
}

contacts

DELETE /contacts/:id

PATCH /contacts/:id

id text primary-key
kind text required
value text required
talent text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"kind": "value",
"value": "value",
"talent": "value"
}

POST /contacts

id text primary-key
kind text required
value text required
talent text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"kind": "value",
"value": "value",
"talent": "value"
}

documents

DELETE /documents/:id

POST /documents

id text primary-key
contents text
kind text required
label text
talent text required
url text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"contents": "value",
"kind": "value",
"label": "value",
"talent": "value",
"url": "value"
}

experiences

DELETE /experiences/:id

PATCH /experiences/:id

id text primary-key
end_date date
presence text
start_date date required
summary text
title text required
work_type text
company text
talent text required
location text

    {
"id": "00000000-0000-0000-0000-000000000000", 
"end_date": "2024-04-29",
"presence": "value",
"start_date": "2024-04-29",
"summary": "value",
"title": "value",
"work_type": "value",
"company": "value",
"talent": "value",
"location": "value"
}

POST /experiences

id text primary-key
end_date date
presence text
start_date date required
summary text
title text required
work_type text
company text
talent text required
location text

    {
"id": "00000000-0000-0000-0000-000000000000", 
"end_date": "2024-04-29",
"presence": "value",
"start_date": "2024-04-29",
"summary": "value",
"title": "value",
"work_type": "value",
"company": "value",
"talent": "value",
"location": "value"
}

invites

DELETE /invites/:id

POST /invites/accept

code text required
terms checkbox
password password

    {
"code": "value", 
"terms": true,
"password": "*****"
}

POST /invites

id text primary-key
email text required
organization text required
role text

    {
"id": "00000000-0000-0000-0000-000000000000", 
"email": "value",
"organization": "value",
"role": "value"
}

jobs

DELETE /jobs/:id

PATCH /jobs/:id

id text primary-key
begins_at date
ends_at date
company text
currency text
description text
exclusive checkbox
kind text
seniority text
location text
max_salary number
min_salary number
name text required
organization text required
presence text
status text required
total_applicants number required
visa_sponsorship checkbox
work_type text

    {
"id": "00000000-0000-0000-0000-000000000000", 
"begins_at": "2024-04-29",
"ends_at": "2024-04-29",
"company": "value",
"currency": "value",
"description": "value",
"exclusive": true,
"kind": "value",
"seniority": "value",
"location": "value",
"max_salary": 1,
"min_salary": 1,
"name": "value",
"organization": "value",
"presence": "value",
"status": "value",
"total_applicants": 1,
"visa_sponsorship": true,
"work_type": "value"
}

GET /jobs/:id

id text primary-key
begins_at date
ends_at date
currency text
description text
exclusive checkbox
kind text
max_salary number
min_salary number
name text required
presence text
seniority text
total_applicants number required
status text required
visa_sponsorship checkbox
work_type text
location text
organization text required
company text

    {
"id": "00000000-0000-0000-0000-000000000000", 
"begins_at": "2024-04-29",
"ends_at": "2024-04-29",
"currency": "value",
"description": "value",
"exclusive": true,
"kind": "value",
"max_salary": 1,
"min_salary": 1,
"name": "value",
"presence": "value",
"seniority": "value",
"total_applicants": 1,
"status": "value",
"visa_sponsorship": true,
"work_type": "value",
"location": "value",
"organization": "value",
"company": "value"
}

POST /jobs

id text primary-key
begins_at date
ends_at date
company text
currency text
description text
exclusive checkbox
kind text
seniority text
location text
max_salary number
min_salary number
name text required
organization text required
presence text
status text required
total_applicants number required
visa_sponsorship checkbox
work_type text

    {
"id": "00000000-0000-0000-0000-000000000000", 
"begins_at": "2024-04-29",
"ends_at": "2024-04-29",
"company": "value",
"currency": "value",
"description": "value",
"exclusive": true,
"kind": "value",
"seniority": "value",
"location": "value",
"max_salary": 1,
"min_salary": 1,
"name": "value",
"organization": "value",
"presence": "value",
"status": "value",
"total_applicants": 1,
"visa_sponsorship": true,
"work_type": "value"
}

GET /jobs

id text primary-key
begins_at date
ends_at date
currency text
description text
exclusive checkbox
kind text
max_salary number
min_salary number
name text required
presence text
seniority text
total_applicants number required
status text required
visa_sponsorship checkbox
work_type text
location text
organization text required
company text

    {
"id": "00000000-0000-0000-0000-000000000000", 
"begins_at": "2024-04-29",
"ends_at": "2024-04-29",
"currency": "value",
"description": "value",
"exclusive": true,
"kind": "value",
"max_salary": 1,
"min_salary": 1,
"name": "value",
"presence": "value",
"seniority": "value",
"total_applicants": 1,
"status": "value",
"visa_sponsorship": true,
"work_type": "value",
"location": "value",
"organization": "value",
"company": "value"
}

locations

GET /locations

id text primary-key
name text required
country text
country_code text required
region_code text
latitude text
longitude text
slug text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"name": "value",
"country": "value",
"country_code": "value",
"region_code": "value",
"latitude": "value",
"longitude": "value",
"slug": "value"
}

login

POST /login

email email required
password password required

    {
"email": "email@example.com", 
"password": "*****"
}

organizations

PATCH /organizations/:id

id text primary-key
enabled checkbox required
gdpr checkbox
gdpr_emails checkbox
gdpr_sourced_threshold number
gdpr_replied_threshold number
gdpr_applied_threshold number
name text required
plan text
seats number required
slug text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"enabled": true,
"gdpr": true,
"gdpr_emails": true,
"gdpr_sourced_threshold": 1,
"gdpr_replied_threshold": 1,
"gdpr_applied_threshold": 1,
"name": "value",
"plan": "value",
"seats": 1,
"slug": "value"
}

POST /organizations

id text primary-key
enabled checkbox required
gdpr checkbox
gdpr_emails checkbox
gdpr_sourced_threshold number
gdpr_replied_threshold number
gdpr_applied_threshold number
name text required
plan text
seats number required
slug text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"enabled": true,
"gdpr": true,
"gdpr_emails": true,
"gdpr_sourced_threshold": 1,
"gdpr_replied_threshold": 1,
"gdpr_applied_threshold": 1,
"name": "value",
"plan": "value",
"seats": 1,
"slug": "value"
}

GET /organizations

id text primary-key
enabled checkbox required
gdpr checkbox
gdpr_emails checkbox
gdpr_sourced_threshold number
gdpr_replied_threshold number
gdpr_applied_threshold number
name text required
plan text
seats number required
slug text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"enabled": true,
"gdpr": true,
"gdpr_emails": true,
"gdpr_sourced_threshold": 1,
"gdpr_replied_threshold": 1,
"gdpr_applied_threshold": 1,
"name": "value",
"plan": "value",
"seats": 1,
"slug": "value"
}

talents

POST /talents/gdpr

code text required
gdpr_expiration date

    {
"code": "value", 
"gdpr_expiration": "2024-04-29"
}

DELETE /talents/:id

PATCH /talents/:id

id text primary-key
birth_date date
currency text
first_name text required
gdpr_expiration date
gdpr_extension date
last_name text required
linkedin text
location text
max_salary number
min_salary number
nationality text
notice_time text
organization text required
presence text
source text
summary text
work_type text

    {
"id": "00000000-0000-0000-0000-000000000000", 
"birth_date": "2024-04-29",
"currency": "value",
"first_name": "value",
"gdpr_expiration": "2024-04-29",
"gdpr_extension": "2024-04-29",
"last_name": "value",
"linkedin": "value",
"location": "value",
"max_salary": 1,
"min_salary": 1,
"nationality": "value",
"notice_time": "value",
"organization": "value",
"presence": "value",
"source": "value",
"summary": "value",
"work_type": "value"
}

GET /talents/:id

id text primary-key
birth_date date
currency text
first_name text required
gdpr_expiration date
gdpr_extension date
last_name text required
linkedin text
max_salary number
min_salary number
nationality text
notice_time text
presence text
source text
summary text
work_type text
location text
organization text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"birth_date": "2024-04-29",
"currency": "value",
"first_name": "value",
"gdpr_expiration": "2024-04-29",
"gdpr_extension": "2024-04-29",
"last_name": "value",
"linkedin": "value",
"max_salary": 1,
"min_salary": 1,
"nationality": "value",
"notice_time": "value",
"presence": "value",
"source": "value",
"summary": "value",
"work_type": "value",
"location": "value",
"organization": "value"
}

GET /talents/export

POST /talents

id text primary-key
birth_date date
currency text
first_name text required
gdpr_expiration date
gdpr_extension date
last_name text required
linkedin text
location text
max_salary number
min_salary number
nationality text
notice_time text
organization text required
presence text
source text
summary text
work_type text

    {
"id": "00000000-0000-0000-0000-000000000000", 
"birth_date": "2024-04-29",
"currency": "value",
"first_name": "value",
"gdpr_expiration": "2024-04-29",
"gdpr_extension": "2024-04-29",
"last_name": "value",
"linkedin": "value",
"location": "value",
"max_salary": 1,
"min_salary": 1,
"nationality": "value",
"notice_time": "value",
"organization": "value",
"presence": "value",
"source": "value",
"summary": "value",
"work_type": "value"
}

GET /talents

id text primary-key
birth_date date
currency text
first_name text required
gdpr_expiration date
gdpr_extension date
last_name text required
linkedin text
max_salary number
min_salary number
nationality text
notice_time text
presence text
source text
summary text
work_type text
location text
organization text required

    {
"id": "00000000-0000-0000-0000-000000000000", 
"birth_date": "2024-04-29",
"currency": "value",
"first_name": "value",
"gdpr_expiration": "2024-04-29",
"gdpr_extension": "2024-04-29",
"last_name": "value",
"linkedin": "value",
"max_salary": 1,
"min_salary": 1,
"nationality": "value",
"notice_time": "value",
"presence": "value",
"source": "value",
"summary": "value",
"work_type": "value",
"location": "value",
"organization": "value"
}

users

DELETE /users/:id

DELETE /users/self

POST /users/reset-password/confirm

code text required
password password required

    {
"code": "value", 
"password": "*****"
}

POST /users/reset-password/start

email email required

    {
"email": "email@example.com"
}

POST /users/verify-email

code text required

    {
"code": "value"
}

POST /users

email email required
password password required

    {
"email": "email@example.com", 
"password": "*****"
}