RoleUp API API Reference

RoleUp is a web application to create job boards. It comes with a website that you can manage from the admin interface. The API is available to let job board owners integrates their jobs data wherever they want.

API Endpoint

https://api.roleup.com/v1

Schemes: https

Version: v1.0.0

Paths

Connect an owner

POST /auth/login

This is the first request to make to obtain a token. The token is used by all other requests as the value of the Authorization header.

Request Content-Types: application/json

Request Example

{
  "email": "string",
  "password": "string"
}

200 OK

Successful request

type

object

Response Content-Types: application/json

Response Example (200 OK)

{
  "access_token": "string"
}

Get the connected Owner

GET /auth/me

Returns the owner details

Authorization: string

in header

Token access_token

200 OK

Successful request

type

object

Response Content-Types: application/json

Response Example (200 OK)

{
  "email": "string",
  "full_name": "string"
}

Get all boards

GET /boards

Returns all boards created by the owner

Authorization: string

in header

Token access_token

200 OK

Board

Successful request

type

Board

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "currency": "string",
    "description": "string",
    "duration": "integer (int32)",
    "host": "string",
    "icon": "string",
    "id": "string",
    "price": "integer (int32)",
    "subtitle": "string",
    "title": "string"
  }
]

Get last published jobs of a board

GET /board/{boardId}/jobs/last

Returns the last published jobs of a specified job board. Maximum 10 jobs

boardId: string

in path

ID of job board to use

Authorization: string

in header

Token access_token

200 OK

Job

Successful request

type

Job

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "application_link": "string",
    "company": "string",
    "company_logo_url": "string",
    "company_url": "string",
    "description": "string",
    "id": "integer (int32)",
    "location": "string",
    "publication_timestamp": "integer (int64)",
    "title": "string"
  }
]

Schema Definitions

Board: object

currency: string: Currency used by the job board
description: string: Description of the job board
duration: integer (int32) x ≥ 1
host: string: Web address of the job board
icon: string: Job board's logo
id: string: Unique identifier of the job board
price: integer (int32) x ≥ 0: Price for employers to do a post
subtitle: string: Job board's subtitle
title: string: Job board's title

Example

{
  "currency": "string",
  "description": "string",
  "duration": "integer (int32)",
  "host": "string",
  "icon": "string",
  "id": "string",
  "price": "integer (int32)",
  "subtitle": "string",
  "title": "string"
}

Job: object

application_link: string: Link where the applicant can apply to the job offer
company: string: Company's name
company_logo_url: string: Company's logo
company_url: string: Company's website
description: string: Job offer's content
id: integer (int32) x ≥ 0: Unique identifier of the job offer in its job board
location: string: Location of the job offer
publication_timestamp: integer (int64): Moment when the job has published as an Unix timestamp
title: string: Job offer's title

Example

{
  "application_link": "string",
  "company": "string",
  "company_logo_url": "string",
  "company_url": "string",
  "description": "string",
  "id": "integer (int32)",
  "location": "string",
  "publication_timestamp": "integer (int64)",
  "title": "string"
}

Documentation by Spectacle