Skip to main content

boards.get

Read one board with its columns and settings

Request
GET/api/v1/boards/{boardId}
Scope required
boards:read
Effect
Reads only. Safe to retry and safe for an agent to call unprompted.
Acts on
Serves an account’s own data and, where shared, an organization’s.
MCP tool
boards_get
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Returns a single board, the seven status columns as ordered lists of application ids, and the settings that govern how it is displayed. The column order is the order a person dragged their cards into, so use it rather than re-sorting the ids yourself. Staff of an organization may read a board an applicant has shared with them — find its id through `organization_shares.list` — but only read it: every write against a board the account does not own answers 404. A board nobody has given the caller access to answers 404, never 403. The response carries a weak `ETag`; send it back as `If-Match` on an update to be refused rather than overwrite a change somebody else made in the meantime.

Parameters

Parameters this endpoint accepts, where each one goes, and whether it is required
NameSent inRequirementAccepts
boardIdpathRequiredstring

Response

applicationCount
integer, required
columns
object, required
accepted
array of string, required
applied
array of string, required
archived
array of string, required
interviewing
array of string, required
offer
array of string, required
rejected
array of string, required
saved
array of string, required
createdAt
string, required
id
string, required
isActive
boolean, required
name
string, required
settings
object, required
autoRetire
object, required
enabled
boolean, required
status
one of: rejected, archived, required
timeframe
one of: one_month, three_months, six_months, one_year, required
hiddenStatuses
array of one of: saved, applied, interviewing, offer, rejected, accepted, archived, required
sorts
array of one of: none, job_title_asc, job_title_desc, company_name_asc, company_name_desc, date_asc, date_desc, required
timeFilter
one of: 7_days, 15_days, 1_month, 3_months, all, required
updatedAt
string, required

Examples

A board with one card waiting in Applied

A board with one card waiting in Applied — request
curl -s https://www.jobapplicationtracking.com/api/v1/boards/brd_7 \
  -H "Authorization: Bearer $JAT_KEY"
A board with one card waiting in Applied — response
{
  "id": "brd_7",
  "name": "Spring search",
  "isActive": true,
  "applicationCount": 12,
  "createdAt": "2026-01-04T09:30:00.000Z",
  "updatedAt": "2026-02-11T17:05:00.000Z",
  "columns": {
    "saved": [],
    "applied": [
      "app_123"
    ],
    "interviewing": [],
    "offer": [],
    "rejected": [],
    "accepted": [],
    "archived": []
  },
  "settings": {
    "hiddenStatuses": [
      "archived"
    ],
    "sorts": [
      "date_desc"
    ],
    "timeFilter": "all",
    "autoRetire": {
      "enabled": false,
      "timeframe": "three_months",
      "status": "rejected"
    }
  }
}

Related operations