GET: /board

This endpoint allows you to retrieve a board info given a key.

get
Source

https://api.hrflow.ai/v1/board
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token
X-USER-EMAIL
required
string
User's email
Query Parameters
key
required
string
Board key
Response
200: OK
Board's info successfully retrieved.
{
"code": 200,
"message": "Board info",
"data": {
"id": 66,
"key": "a9f42c53255d3774a0b997849ea1d52cc3192f4d",
"name": "hiring campain",
"description": "archive",
"type": "api",
"subtype": "python",
"status": true,
"archive": null,
"members": [
"alaeddine.chhima@riminder.net"
],
"user": {
"id": 221,
"email": "alaeddine.chhima@riminder.net",
"pseudo": null,
"firstName": null,
"lastName": null,
"avatarUrl": "/images/user.png",
"locale": "english",
"position": null,
"phone": null
},
"mapping_scoring": [],
"mapping_reasoning": [],
"updated_at": "2020-08-31T09:47:40+0000",
"created_at": "2020-08-31T09:46:07+0000"
}
}
400: Bad Request
Coulf not find a board matching this query
{
"code": 400,
"message": "Invalid board fields"
}
401: Unauthorized
Invalid secret key
{
"code": 401,
"message": "Unauthorized. Invalid secret key: xxxxx "
}

Example

Python
Javascript
Python
from hrflow import Hrflow
client = Hrflow(api_secret: "Your API Key", api_user: "Your API user email")
client.board.get(key="board_key")
Javascript
import Hrflow from 'hrflow';
const client = new Hrflow({
api_secret: 'Your API Key',
api_user: 'Your API user email'
});
client.board.get('board_key').then(response => {
console.log(response);
// ...
});