Skip to main content

shares.create

Share a board with an organization

Request
POST/api/v1/boards/{boardId}/shares
Scope required
boards:write
Effect
Changes data. Send an Idempotency-Key if you might retry it.
Acts on
Acts on the account’s own job search.
MCP tool
shares_create
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Gives an organization read-only sight of one board, so its coaches can follow the search and leave notes on the applications. The account must already be an applicant member of that organization — accept the invitation with `invitations.accept` first — and sharing a board that is already shared with the same organization answers with the existing share rather than failing. Withdraw it with `shares.delete`; `shares.list` shows everything currently shared.

Parameters

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

Request body

organizationSlug
string, required

Response

boardId
string, required
boardName
string, required
createdAt
string, required
id
string, required
organization
object, required
name
string, required
slug
string, required

Examples

Let a career centre follow the spring search

Let a career centre follow the spring search — request
curl -s -X POST https://www.jobapplicationtracking.com/api/v1/boards/brd_7/shares \
  -H "Authorization: Bearer $JAT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "organizationSlug": "northwind-careers"
}'
Let a career centre follow the spring search — response
{
  "id": "shr_42",
  "boardId": "brd_7",
  "boardName": "Spring search",
  "organization": {
    "slug": "northwind-careers",
    "name": "Northwind Careers"
  },
  "createdAt": "2026-02-01T09:30:00.000Z"
}

Related operations