Skip to main content

invitations.accept

Accept an organization invitation

Request
POST/api/v1/invitations/{invitationId}/accept
Scope required
organizations: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
invitations_accept
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Joins the organization in the role the invitation offered, and answers with that organization and role. Accepting as an applicant shares nothing on its own: the organization sees a board only once `shares.create` has been called for it. An invitation that has expired, been revoked, or already been answered is refused, and one addressed to anybody else answers 404. List what is waiting with `invitations.list_mine`.

Parameters

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

Response

organizationSlug
string, required
role
one of: owner, admin, coach, applicant, required

Examples

Join a college career centre as an applicant

Join a college career centre as an applicant — request
curl -s -X POST https://www.jobapplicationtracking.com/api/v1/invitations/inv_3f1b0c2e-6d5a-4f7b-9c8d-0a1b2c3d4e5f/accept \
  -H "Authorization: Bearer $JAT_KEY"
Join a college career centre as an applicant — response
{
  "organizationSlug": "northwind-careers",
  "role": "applicant"
}

Related operations