GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints
Live AI Demo

🔌 Find Boards in a Workspace

get
https://api.hrflow.ai/v1/boards

Retrieve all boards for given team account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Prerequisites

  1. ✨ Create a Workspace
  2. 🔑 Get your API Key
  3. 🔌 Create a Board

Request headers

FieldValue
X-API-KEYYour API Key.
X-USER-EMAILYour HrFlow.ai account's email.
Query Params
string

The Board name. If this value is empty the API will return all possible values.

string

The environment in which the Source has been created: production, staging, test. If this value is empty the API will return all possible values.

int32
Defaults to 1

API page offset. By specifying the page offset, you retrieve a subset of records starting from the page offset. This page offset works with the limit parameter.

int32
Defaults to 30

This parameter sets the number of entities by page, by default, we will return pages of 30 entities.

string
Defaults to desc

The type to order results by creation date by asc or desc. The default value is desc.

Responses

Updated 4 months ago

What’s Next

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

What’s Next