Skip to content

Careers Orbit management API

Read and change jobs, applications and candidates from your own scripts and systems.

The management API is for your own scripts and other systems, such as an HR system that picks up new hires. It needs a management token (careers_mt_) and acts as the person who created it, with their current role and permissions. A read-only token gets 403 on every change. It is in the Growth and Enterprise plans.

Applications and candidates come 50 at a time, or limit up to 100; when there are more, meta.next holds a cursor to send back as cursor. The job list comes in one answer. Answers are never cached. There is no endpoint to erase candidates or send emails.

Each network may make 120 requests a minute with one token. Going over answers 429 rate_limited; no rate-limit headers are sent, so wait a minute and try again. Errors are { error: { code, message } }, with issues on 422.

Read the guideOpenAPI 3.1 document

Try it settings

https://app.bifrostorbit.com/careers/api/v1

The management API takes a management token, which is secret, so nothing here is sent from the docs. Use the API playground in Careers Orbit, or your server.

Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.

TokenWho the token acts as.

Who the token is

GET/meKey required

The organisation, the person the token acts as, their role and their permissions.

Responses

  • 200OKThe token's person.
    • dataobject

      Fields of data
      • organisationobject

        Fields of organisation
        • idstring

        • namestring

      • personobject

        Fields of person
        • idstring

        • namestring

        • emailstring

      • rolestring

      • permissionsstring[]

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl 'https://app.bifrostorbit.com/careers/api/v1/me' \  -H 'Authorization: Bearer careers_mt_…'

Try it

Management tokens are secret; use them from a server or the API playground in Careers Orbit.

Example answer

200 OKJSON
{  "data": {    "organisation": {      "id": "6651a0c2b9e4c1d2e3f40a01",      "name": "Northwilds"    },    "person": {      "id": "6651a0c2b9e4c1d2e3f40f01",      "name": "Ingrid Berg",      "email": "ingrid.berg@northwilds.com"    },    "role": "recruiter",    "permissions": [      "jobs:write",      "jobs:publish",      "candidates:read",      "applications:move",      "applications:reject",      "messages:send",      "notes:write"    ]  }}

JobsEvery job, and publishing or closing one.

List jobs

GET/jobsKey required

Every job, drafts and closed ones too, most recently changed first, in one answer of up to 500 jobs. Not paged.

Parameters

  • statusstringquery

    open, or one of draft, inReview, published, internal, closed, archived.

Responses

  • 200OKThe jobs.
    • dataJob[]

      Fields of data
      • idstring

      • slugstring

      • statusstring

        One of draft, inReview, published, internal, closed, archived.
      • titlestring

      • summarystringsometimes

      • descriptionstringsometimes

      • seoTitlestring or nullsometimes

      • seoDescriptionstring or nullsometimes

      • translationsmap of anysometimes

        Only what differs, by language.

      • employmentTypestring

        One of fullTime, partTime, contract, temporary, internship, apprenticeship, workingStudent.
      • remotestring

        One of onsite, hybrid, remote.
      • departmentIdstring or null

      • locationIdsstring[]

      • salaryany or any or null

      • ownerIdstring or null

      • hiringTeamany[]

      • pipelineIdstring or null

      • publishAtstring or null

      • closeAtstring or null

      • publishedAtstring or null

      • closedAtstring or null

      • createdAtstring or null

      • updatedAtstring or null

  • 400Bad requestAn unknown status.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl 'https://app.bifrostorbit.com/careers/api/v1/jobs' \  -H 'Authorization: Bearer careers_mt_…'

Try it

Management tokens are secret.

Example answer

200 OKJSON
{  "data": [    {      "id": "6651a0c2b9e4c1d2e3f40b01",      "slug": "trip-guide-lofoten",      "status": "published",      "title": "Trip guide, Lofoten",      "employmentType": "temporary",      "remote": "onsite",      "departmentId": "6651a0c2b9e4c1d2e3f40a11",      "locationIds": [        "6651a0c2b9e4c1d2e3f40a21"      ],      "salary": {        "min": 42000,        "max": 48000,        "currency": "NOK",        "period": "month",        "shown": true      },      "ownerId": "6651a0c2b9e4c1d2e3f40f01",      "hiringTeam": [        "6651a0c2b9e4c1d2e3f40f01"      ],      "pipelineId": "6651a0c2b9e4c1d2e3f40a31",      "publishAt": null,      "closeAt": "2027-01-31T23:00:00.000Z",      "publishedAt": "2026-10-20T08:00:00.000Z",      "closedAt": null,      "createdAt": "2026-10-14T10:05:00.000Z",      "updatedAt": "2026-10-20T08:00:00.000Z"    }  ]}

Get a job

GET/jobs/{jobId}Key required

With its text in the main language, and translations holding only what differs in each other language.

Parameters

  • jobIdstringpath, required

    The job's id.

Responses

  • 200OKThe job.
    • dataJob

      A job. The text fields only on one job.

      Fields of data
      • idstring

      • slugstring

      • statusstring

        One of draft, inReview, published, internal, closed, archived.
      • titlestring

      • summarystringsometimes

      • descriptionstringsometimes

      • seoTitlestring or nullsometimes

      • seoDescriptionstring or nullsometimes

      • translationsmap of anysometimes

        Only what differs, by language.

      • employmentTypestring

        One of fullTime, partTime, contract, temporary, internship, apprenticeship, workingStudent.
      • remotestring

        One of onsite, hybrid, remote.
      • departmentIdstring or null

      • locationIdsstring[]

      • salaryany or any or null

      • ownerIdstring or null

      • hiringTeamany[]

      • pipelineIdstring or null

      • publishAtstring or null

      • closeAtstring or null

      • publishedAtstring or null

      • closedAtstring or null

      • createdAtstring or null

      • updatedAtstring or null

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 404Not foundNo such job.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl 'https://app.bifrostorbit.com/careers/api/v1/jobs/6651a0c2b9e4c1d2e3f40b01' \  -H 'Authorization: Bearer careers_mt_…'

Try it

Management tokens are secret.

Example answer

200 OKJSON
{  "data": {    "id": "6651a0c2b9e4c1d2e3f40b01",    "slug": "trip-guide-lofoten",    "status": "published",    "title": "Trip guide, Lofoten",    "employmentType": "temporary",    "remote": "onsite",    "departmentId": "6651a0c2b9e4c1d2e3f40a11",    "locationIds": [      "6651a0c2b9e4c1d2e3f40a21"    ],    "salary": {      "min": 42000,      "max": 48000,      "currency": "NOK",      "period": "month",      "shown": true    },    "ownerId": "6651a0c2b9e4c1d2e3f40f01",    "hiringTeam": [      "6651a0c2b9e4c1d2e3f40f01"    ],    "pipelineId": "6651a0c2b9e4c1d2e3f40a31",    "publishAt": null,    "closeAt": "2027-01-31T23:00:00.000Z",    "publishedAt": "2026-10-20T08:00:00.000Z",    "closedAt": null,    "createdAt": "2026-10-14T10:05:00.000Z",    "updatedAt": "2026-10-20T08:00:00.000Z",    "summary": "Lead small groups on sea kayaking and ridge walks in Lofoten, from May to September.",    "description": "<p>You will guide groups of up to eight on our Lofoten sea kayaking and ridge walk trips.</p><ul><li>Kayak guide or mountain leader certificate</li><li>First aid at work</li></ul>",    "seoTitle": null,    "seoDescription": null,    "translations": {      "nb": {        "title": "Turleder, Lofoten"      }    }  }}

Publish or close a job

POST/jobs/{jobId}/statusKey required

Checks reviews, the job's required details and your plan's limit on live jobs, as Careers Orbit does.

Parameters

  • jobIdstringpath, required

    The job's id.

Request body

  • statusstringrequired

    One of published, internal, closed, archived, draft.

Responses

  • 200OKThe job.
    • dataJob

      A job. The text fields only on one job.

      Fields of data
      • idstring

      • slugstring

      • statusstring

        One of draft, inReview, published, internal, closed, archived.
      • titlestring

      • summarystringsometimes

      • descriptionstringsometimes

      • seoTitlestring or nullsometimes

      • seoDescriptionstring or nullsometimes

      • translationsmap of anysometimes

        Only what differs, by language.

      • employmentTypestring

        One of fullTime, partTime, contract, temporary, internship, apprenticeship, workingStudent.
      • remotestring

        One of onsite, hybrid, remote.
      • departmentIdstring or null

      • locationIdsstring[]

      • salaryany or any or null

      • ownerIdstring or null

      • hiringTeamany[]

      • pipelineIdstring or null

      • publishAtstring or null

      • closeAtstring or null

      • publishedAtstring or null

      • closedAtstring or null

      • createdAtstring or null

      • updatedAtstring or null

  • 400Bad requestThe job is missing something it needs to go live.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not publish, the job needs a review first, the plan's limit on live jobs is reached, or the token is read-only.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 404Not foundNo such job.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 409ConflictThe job is in the bin.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 422UnprocessableAn unknown status.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/careers/api/v1/jobs/6651a0c2b9e4c1d2e3f40b01/status' \  -H 'Authorization: Bearer careers_mt_…' \  -H 'Content-Type: application/json' \  -d '{"status":"closed"}'

Try it

It changes real jobs or candidates and can start automations that email them.

Example answer

200 OKJSON
{  "data": {    "id": "6651a0c2b9e4c1d2e3f40b01",    "slug": "trip-guide-lofoten",    "status": "closed",    "title": "Trip guide, Lofoten",    "employmentType": "temporary",    "remote": "onsite",    "departmentId": "6651a0c2b9e4c1d2e3f40a11",    "locationIds": [      "6651a0c2b9e4c1d2e3f40a21"    ],    "salary": {      "min": 42000,      "max": 48000,      "currency": "NOK",      "period": "month",      "shown": true    },    "ownerId": "6651a0c2b9e4c1d2e3f40f01",    "hiringTeam": [      "6651a0c2b9e4c1d2e3f40f01"    ],    "pipelineId": "6651a0c2b9e4c1d2e3f40a31",    "publishAt": null,    "closeAt": "2027-01-31T23:00:00.000Z",    "publishedAt": "2026-10-20T08:00:00.000Z",    "closedAt": "2026-11-02T09:30:00.000Z",    "createdAt": "2026-10-14T10:05:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z",    "summary": "Lead small groups on sea kayaking and ridge walks in Lofoten, from May to September.",    "description": "<p>You will guide groups of up to eight on our Lofoten sea kayaking and ridge walk trips.</p><ul><li>Kayak guide or mountain leader certificate</li><li>First aid at work</li></ul>",    "seoTitle": null,    "seoDescription": null,    "translations": {      "nb": {        "title": "Turleder, Lofoten"      }    }  }}

PipelinesStages and rejection reasons.

List pipelines and stages

GET/stagesKey required

Pipelines with their stages and stage types, and the rejection reasons.

Responses

  • 200OKThe pipelines.
    • dataobject[]

      Fields of data
      • idstring

      • namestring

      • isDefaultboolean

      • stagesobject[]

        Fields of stages
        • idstring

        • namestring

        • typestring

        • publicNamestring or null

    • rejectionReasonsany[]

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl 'https://app.bifrostorbit.com/careers/api/v1/stages' \  -H 'Authorization: Bearer careers_mt_…'

Try it

Management tokens are secret.

Example answer

200 OKJSON
{  "data": [    {      "id": "6651a0c2b9e4c1d2e3f40a31",      "name": "Guides",      "isDefault": true,      "stages": [        {          "id": "new",          "name": "New",          "type": "new",          "publicName": "Received"        },        {          "id": "screening",          "name": "Screening",          "type": "screening",          "publicName": "Being reviewed"        },        {          "id": "interview",          "name": "Interview",          "type": "interview",          "publicName": "Interviews"        },        {          "id": "offer",          "name": "Offer",          "type": "offer",          "publicName": "Offer"        },        {          "id": "hired",          "name": "Hired",          "type": "hired",          "publicName": "Hired"        },        {          "id": "rejected",          "name": "Not taken forward",          "type": "rejected",          "publicName": "Closed"        }      ]    }  ],  "rejectionReasons": [    {      "id": "experience",      "label": "Not enough relevant experience"    },    {      "id": "location",      "label": "Can't work where the job is"    },    {      "id": "other-candidate",      "label": "We chose another candidate"    }  ]}

ApplicationsApplications, moving and rejecting.

List applications

GET/applicationsKey required

Newest first, without answers, 50 at a time: when meta.next isn't null, send it back as cursor for the next page.

Parameters

  • jobIdstringquery

    Only this job.

  • statusstringquery

    active, rejected, withdrawn or hired.

    One of active, rejected, withdrawn, hired.
  • stageIdstringquery

    Only this stage.

  • updatedSincestringquery

    Such as 2026-10-01T00:00:00Z.

  • limitintegerquery

    50 unless you say, up to 100. Larger values are capped at 100.

    Default 50. At least 1. At most 100.
  • cursorstringquery

    meta.next from the page before. Leave it out for the first page.

Responses

  • 200OKA page.
    • dataApplication[]

      Fields of data
      • idstring

      • jobIdstring

      • candidateIdstring

      • stageIdstring

      • stageTypestring or null

      • statusstring

        One of active, rejected, withdrawn, hired.
      • sourcestring

      • sourceDetailobject or null

        Where the candidate came from, when known.

        Fields of sourceDetail
        • utmSourcestring or null

        • utmMediumstring or null

        • utmCampaignstring or null

        • referrerstring or null

      • knockedOutboolean

        Failed a screening rule.

      • fieldsmap of anysometimes

        On one application: the standard fields.

      • answersobject[]sometimes

        On one application: the answers, in the form's order.

        Fields of answers
        • questionIdstring

        • kindstring

          One of text, longText, choice, multiChoice, yesNo, file, date, number.
        • labelstring

          The question as it was asked.

        • valueany

          Text, a list of option ids, a number, yes or no as a boolean, or null.

      • rejectionany or any or nullsometimes

      • withdrawalany or any or nullsometimes

      • cvFileIdstring or nullsometimes

      • fileIdsstring[]sometimes

      • appliedAtstring or null

      • updatedAtstring or null

    • metaobject

      Fields of meta
      • limitinteger

        Items a page.

      • nextstring or null

        Send as cursor for the next page. null on the last page.

  • 400Bad requestA cursor that isn't one, or updatedSince that isn't a date.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl 'https://app.bifrostorbit.com/careers/api/v1/applications' \  -H 'Authorization: Bearer careers_mt_…'

Try it

Management tokens are secret.

Example answer

200 OKJSON
{  "data": [    {      "id": "6651a0c2b9e4c1d2e3f40c01",      "jobId": "6651a0c2b9e4c1d2e3f40b01",      "candidateId": "6651a0c2b9e4c1d2e3f40e01",      "stageId": "interview",      "stageType": "interview",      "status": "active",      "source": "website",      "sourceDetail": {        "utmSource": "newsletter",        "utmMedium": "email",        "utmCampaign": "summer-guides",        "referrer": "https://northwilds.com/"      },      "knockedOut": false,      "appliedAt": "2026-10-24T18:12:00.000Z",      "updatedAt": "2026-11-02T09:30:00.000Z"    }  ],  "meta": {    "limit": 50,    "next": null  }}

Get an application

GET/applications/{applicationId}Key required

With the candidate's answers and file ids. Recorded in the audit trail.

Parameters

  • applicationIdstringpath, required

    The application's id.

Responses

  • 200OKThe application.
    • dataApplication

      Fields of data
      • idstring

      • jobIdstring

      • candidateIdstring

      • stageIdstring

      • stageTypestring or null

      • statusstring

        One of active, rejected, withdrawn, hired.
      • sourcestring

      • sourceDetailobject or null

        Where the candidate came from, when known.

        Fields of sourceDetail
        • utmSourcestring or null

        • utmMediumstring or null

        • utmCampaignstring or null

        • referrerstring or null

      • knockedOutboolean

        Failed a screening rule.

      • fieldsmap of anysometimes

        On one application: the standard fields.

      • answersobject[]sometimes

        On one application: the answers, in the form's order.

        Fields of answers
        • questionIdstring

        • kindstring

          One of text, longText, choice, multiChoice, yesNo, file, date, number.
        • labelstring

          The question as it was asked.

        • valueany

          Text, a list of option ids, a number, yes or no as a boolean, or null.

      • rejectionany or any or nullsometimes

      • withdrawalany or any or nullsometimes

      • cvFileIdstring or nullsometimes

      • fileIdsstring[]sometimes

      • appliedAtstring or null

      • updatedAtstring or null

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 404Not foundNo such application, or not one the token's person may read.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl 'https://app.bifrostorbit.com/careers/api/v1/applications/6651a0c2b9e4c1d2e3f40c01' \  -H 'Authorization: Bearer careers_mt_…'

Try it

Management tokens are secret.

Example answer

200 OKJSON
{  "data": {    "id": "6651a0c2b9e4c1d2e3f40c01",    "jobId": "6651a0c2b9e4c1d2e3f40b01",    "candidateId": "6651a0c2b9e4c1d2e3f40e01",    "stageId": "interview",    "stageType": "interview",    "status": "active",    "source": "website",    "sourceDetail": {      "utmSource": "newsletter",      "utmMedium": "email",      "utmCampaign": "summer-guides",      "referrer": "https://northwilds.com/"    },    "knockedOut": false,    "appliedAt": "2026-10-24T18:12:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z",    "fields": {      "phone": "+47 912 34 567",      "coverLetter": "I have guided sea kayak trips around Lofoten for three summers.",      "linkedin": null,      "location": "Bodø",      "salaryExpectation": null,      "startDate": "2027-05-01"    },    "answers": [      {        "questionId": "certificate",        "kind": "choice",        "label": "Which guiding certificate do you hold?",        "value": "kayak"      },      {        "questionId": "season",        "kind": "yesNo",        "label": "Can you work the whole season, May to September?",        "value": true      }    ],    "rejection": null,    "withdrawal": null,    "cvFileId": "6651a0c2b9e4c1d2e3f40d01",    "fileIds": [      "6651a0c2b9e4c1d2e3f40d01"    ]  }}

Move to a stage

POST/applications/{applicationId}/moveKey required

Runs the stage's automations, which may email the candidate. Moving to the rejected stage is refused: use reject.

Parameters

  • applicationIdstringpath, required

    The application's id.

Request body

  • stageIdstringrequired

Responses

  • 200OKThe application.
    • dataApplication

      Fields of data
      • idstring

      • jobIdstring

      • candidateIdstring

      • stageIdstring

      • stageTypestring or null

      • statusstring

        One of active, rejected, withdrawn, hired.
      • sourcestring

      • sourceDetailobject or null

        Where the candidate came from, when known.

        Fields of sourceDetail
        • utmSourcestring or null

        • utmMediumstring or null

        • utmCampaignstring or null

        • referrerstring or null

      • knockedOutboolean

        Failed a screening rule.

      • fieldsmap of anysometimes

        On one application: the standard fields.

      • answersobject[]sometimes

        On one application: the answers, in the form's order.

        Fields of answers
        • questionIdstring

        • kindstring

          One of text, longText, choice, multiChoice, yesNo, file, date, number.
        • labelstring

          The question as it was asked.

        • valueany

          Text, a list of option ids, a number, yes or no as a boolean, or null.

      • rejectionany or any or nullsometimes

      • withdrawalany or any or nullsometimes

      • cvFileIdstring or nullsometimes

      • fileIdsstring[]sometimes

      • appliedAtstring or null

      • updatedAtstring or null

  • 400Bad requestThe stage isn't in the job's pipeline, or it is the rejected stage.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 404Not foundNo such application, or not one the token's person may read.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 422UnprocessableNo stageId.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/careers/api/v1/applications/6651a0c2b9e4c1d2e3f40c01/move' \  -H 'Authorization: Bearer careers_mt_…' \  -H 'Content-Type: application/json' \  -d '{"stageId":"interview"}'

Try it

It changes real jobs or candidates and can start automations that email them.

Example answer

200 OKJSON
{  "data": {    "id": "6651a0c2b9e4c1d2e3f40c01",    "jobId": "6651a0c2b9e4c1d2e3f40b01",    "candidateId": "6651a0c2b9e4c1d2e3f40e01",    "stageId": "interview",    "stageType": "interview",    "status": "active",    "source": "website",    "sourceDetail": {      "utmSource": "newsletter",      "utmMedium": "email",      "utmCampaign": "summer-guides",      "referrer": "https://northwilds.com/"    },    "knockedOut": false,    "appliedAt": "2026-10-24T18:12:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z",    "fields": {      "phone": "+47 912 34 567",      "coverLetter": "I have guided sea kayak trips around Lofoten for three summers.",      "linkedin": null,      "location": "Bodø",      "salaryExpectation": null,      "startDate": "2027-05-01"    },    "answers": [      {        "questionId": "certificate",        "kind": "choice",        "label": "Which guiding certificate do you hold?",        "value": "kayak"      },      {        "questionId": "season",        "kind": "yesNo",        "label": "Can you work the whole season, May to September?",        "value": true      }    ],    "rejection": null,    "withdrawal": null,    "cvFileId": "6651a0c2b9e4c1d2e3f40d01",    "fileIds": [      "6651a0c2b9e4c1d2e3f40d01"    ]  }}

Reject

POST/applications/{applicationId}/rejectKey required

With a reason from the stages endpoint, and an optional note for the team, up to 500 characters.

Parameters

  • applicationIdstringpath, required

    The application's id.

Request body

  • reasonIdstringrequired

  • notestring or nulloptional

    Up to 500 characters.

Responses

  • 200OKThe application.
    • dataApplication

      Fields of data
      • idstring

      • jobIdstring

      • candidateIdstring

      • stageIdstring

      • stageTypestring or null

      • statusstring

        One of active, rejected, withdrawn, hired.
      • sourcestring

      • sourceDetailobject or null

        Where the candidate came from, when known.

        Fields of sourceDetail
        • utmSourcestring or null

        • utmMediumstring or null

        • utmCampaignstring or null

        • referrerstring or null

      • knockedOutboolean

        Failed a screening rule.

      • fieldsmap of anysometimes

        On one application: the standard fields.

      • answersobject[]sometimes

        On one application: the answers, in the form's order.

        Fields of answers
        • questionIdstring

        • kindstring

          One of text, longText, choice, multiChoice, yesNo, file, date, number.
        • labelstring

          The question as it was asked.

        • valueany

          Text, a list of option ids, a number, yes or no as a boolean, or null.

      • rejectionany or any or nullsometimes

      • withdrawalany or any or nullsometimes

      • cvFileIdstring or nullsometimes

      • fileIdsstring[]sometimes

      • appliedAtstring or null

      • updatedAtstring or null

  • 400Bad requestAn unknown reason.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 404Not foundNo such application, or not one the token's person may read.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 422UnprocessableNo reasonId, or a note that is too long.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/careers/api/v1/applications/6651a0c2b9e4c1d2e3f40c01/reject' \  -H 'Authorization: Bearer careers_mt_…' \  -H 'Content-Type: application/json' \  -d '{"reasonId":"other-candidate","note":"Strong candidate; ask again next season."}'

Try it

It changes real jobs or candidates and can start automations that email them.

Example answer

200 OKJSON
{  "data": {    "id": "6651a0c2b9e4c1d2e3f40c01",    "jobId": "6651a0c2b9e4c1d2e3f40b01",    "candidateId": "6651a0c2b9e4c1d2e3f40e01",    "stageId": "rejected",    "stageType": "rejected",    "status": "rejected",    "source": "website",    "sourceDetail": {      "utmSource": "newsletter",      "utmMedium": "email",      "utmCampaign": "summer-guides",      "referrer": "https://northwilds.com/"    },    "knockedOut": false,    "appliedAt": "2026-10-24T18:12:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z",    "fields": {      "phone": "+47 912 34 567",      "coverLetter": "I have guided sea kayak trips around Lofoten for three summers.",      "linkedin": null,      "location": "Bodø",      "salaryExpectation": null,      "startDate": "2027-05-01"    },    "answers": [      {        "questionId": "certificate",        "kind": "choice",        "label": "Which guiding certificate do you hold?",        "value": "kayak"      },      {        "questionId": "season",        "kind": "yesNo",        "label": "Can you work the whole season, May to September?",        "value": true      }    ],    "rejection": {      "reasonId": "other-candidate",      "reason": "We chose another candidate",      "by": "6651a0c2b9e4c1d2e3f40f01",      "at": "2026-11-02T09:30:00.000Z"    },    "withdrawal": null,    "cvFileId": "6651a0c2b9e4c1d2e3f40d01",    "fileIds": [      "6651a0c2b9e4c1d2e3f40d01"    ]  }}

CandidatesCandidates, tags and notes.

List candidates

GET/candidatesKey required

Newest first, 50 at a time: when meta.next isn't null, send it back as cursor for the next page. Recorded in the audit trail.

Parameters

  • qstringquery

    Words in the name or email.

  • emailstringquery

    One exact address.

  • tagstringquery

    Only candidates with this tag.

  • limitintegerquery

    50 unless you say, up to 100. Larger values are capped at 100.

    Default 50. At least 1. At most 100.
  • cursorstringquery

    meta.next from the page before. Leave it out for the first page.

Responses

  • 200OKA page.
    • dataCandidate[]

      Fields of data
      • idstring

      • firstNamestring

      • lastNamestring

      • emailstring

      • phonestring or null

      • locationstring or null

      • linksany

      • tagsstring[]

      • talentPoolany

      • localestring or null

      • applicationsobject[]sometimes

        On one candidate.

        Fields of applications
        • idstring

        • jobIdstring

        • stageIdstring

        • statusstring

        • appliedAtstring or null

      • createdAtstring or null

      • lastActivityAtstring or null

    • metaobject

      Fields of meta
      • limitinteger

        Items a page.

      • nextstring or null

        Send as cursor for the next page. null on the last page.

  • 400Bad requestA cursor that isn't one.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl 'https://app.bifrostorbit.com/careers/api/v1/candidates' \  -H 'Authorization: Bearer careers_mt_…'

Try it

Management tokens are secret.

Example answer

200 OKJSON
{  "data": [    {      "id": "6651a0c2b9e4c1d2e3f40e01",      "firstName": "Kari",      "lastName": "Nordmann",      "email": "kari.nordmann@northwilds.com",      "phone": "+47 912 34 567",      "location": "Bodø",      "links": [],      "tags": [        "Glacier certified"      ],      "talentPool": true,      "locale": "en",      "createdAt": "2026-10-24T18:12:00.000Z",      "lastActivityAt": "2026-11-02T09:30:00.000Z"    }  ],  "meta": {    "limit": 50,    "next": null  }}

Get a candidate

GET/candidates/{candidateId}Key required

With the applications you may read. Recorded in the audit trail.

Parameters

  • candidateIdstringpath, required

    The candidate's id.

Responses

  • 200OKThe candidate.
    • dataCandidate

      Fields of data
      • idstring

      • firstNamestring

      • lastNamestring

      • emailstring

      • phonestring or null

      • locationstring or null

      • linksany

      • tagsstring[]

      • talentPoolany

      • localestring or null

      • applicationsobject[]sometimes

        On one candidate.

        Fields of applications
        • idstring

        • jobIdstring

        • stageIdstring

        • statusstring

        • appliedAtstring or null

      • createdAtstring or null

      • lastActivityAtstring or null

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 404Not foundNo such candidate, or not one the token's person may read.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl 'https://app.bifrostorbit.com/careers/api/v1/candidates/6651a0c2b9e4c1d2e3f40e01' \  -H 'Authorization: Bearer careers_mt_…'

Try it

Management tokens are secret.

Example answer

200 OKJSON
{  "data": {    "id": "6651a0c2b9e4c1d2e3f40e01",    "firstName": "Kari",    "lastName": "Nordmann",    "email": "kari.nordmann@northwilds.com",    "phone": "+47 912 34 567",    "location": "Bodø",    "links": [],    "tags": [      "Glacier certified"    ],    "talentPool": true,    "locale": "en",    "createdAt": "2026-10-24T18:12:00.000Z",    "lastActivityAt": "2026-11-02T09:30:00.000Z",    "applications": [      {        "id": "6651a0c2b9e4c1d2e3f40c01",        "jobId": "6651a0c2b9e4c1d2e3f40b01",        "stageId": "interview",        "status": "active",        "appliedAt": "2026-10-24T18:12:00.000Z"      }    ]  }}

Tag a candidate

POST/candidates/{candidateId}/tagsKey required

A tag of up to 40 characters. remove: true takes the tag off.

Parameters

  • candidateIdstringpath, required

    The candidate's id.

Request body

  • tagstringrequired

    Up to 40 characters.
  • removebooleanoptional

Responses

  • 200OKThe candidate.
    • dataCandidate

      Fields of data
      • idstring

      • firstNamestring

      • lastNamestring

      • emailstring

      • phonestring or null

      • locationstring or null

      • linksany

      • tagsstring[]

      • talentPoolany

      • localestring or null

      • applicationsobject[]sometimes

        On one candidate.

        Fields of applications
        • idstring

        • jobIdstring

        • stageIdstring

        • statusstring

        • appliedAtstring or null

      • createdAtstring or null

      • lastActivityAtstring or null

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not do this, the token is read-only, or the plan doesn't include the management API.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 404Not foundNo such candidate, or not one the token's person may read.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 422UnprocessableNo tag, or one that is too long.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/careers/api/v1/candidates/6651a0c2b9e4c1d2e3f40e01/tags' \  -H 'Authorization: Bearer careers_mt_…' \  -H 'Content-Type: application/json' \  -d '{"tag":"Glacier certified"}'

Try it

It changes real jobs or candidates and can start automations that email them.

Example answer

200 OKJSON
{  "data": {    "id": "6651a0c2b9e4c1d2e3f40e01",    "firstName": "Kari",    "lastName": "Nordmann",    "email": "kari.nordmann@northwilds.com",    "phone": "+47 912 34 567",    "location": "Bodø",    "links": [],    "tags": [      "Glacier certified"    ],    "talentPool": true,    "locale": "en",    "createdAt": "2026-10-24T18:12:00.000Z",    "lastActivityAt": "2026-11-02T09:30:00.000Z",    "applications": [      {        "id": "6651a0c2b9e4c1d2e3f40c01",        "jobId": "6651a0c2b9e4c1d2e3f40b01",        "stageId": "interview",        "status": "active",        "appliedAt": "2026-10-24T18:12:00.000Z"      }    ]  }}

Add a note

POST/candidates/{candidateId}/notesKey required

Mentions notify colleagues. With applicationId, the note belongs to that application.

Parameters

  • candidateIdstringpath, required

    The candidate's id.

Request body

  • bodystringrequired

    Up to 5000 characters.
  • applicationIdstring or nulloptional

Responses

  • 201CreatedThe note.
    • dataany

  • 401UnauthorisedA missing, wrong, revoked or expired token, or a person who no longer has Careers Orbit.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 403ForbiddenThe token's person may not leave notes on this candidate, or the token is read-only.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 404Not foundNo such candidate, or not one the token's person may read.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 422UnprocessableNo body, or one over 5,000 characters.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 429Too many requestsMore than 120 requests a minute from one network with one token.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

  • 500Server errorSomething failed on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

      • messagestring

        A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

    • issuesany[]sometimes

      On 422: the fields that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/careers/api/v1/candidates/6651a0c2b9e4c1d2e3f40e01/notes' \  -H 'Authorization: Bearer careers_mt_…' \  -H 'Content-Type: application/json' \  -d '{"body":"Strong on glacier safety. Ask about the Svartisen course in the interview.","applicationId":"6651a0c2b9e4c1d2e3f40c01"}'

Try it

It changes real jobs or candidates and can start automations that email them.

Example answer

201 CreatedJSON
{  "data": {    "type": "note",    "id": "6651a0c2b9e4c1d2e3f40e11",    "at": "2026-11-02T09:30:00.000Z",    "who": "Ingrid Berg",    "whoId": "6651a0c2b9e4c1d2e3f40f01",    "body": "Strong on glacier safety. Ask about the Svartisen course in the interview.",    "jobId": "6651a0c2b9e4c1d2e3f40b01",    "applicationId": "6651a0c2b9e4c1d2e3f40c01",    "drafted": null  }}

SchemasThe shapes the endpoints above answer with and take.

Error

Every error has this shape. Write code against the status and code, never the message.

  • errorobject

    Fields of error
    • codestring

      unauthorized, forbidden, not_found, subscription_inactive, invalid, conflict, rate_limited or server_error.

    • messagestring

      A message people can read. Messages meant for candidates follow their language where Careers Orbit has it; the rest are in English.

  • issuesany[]sometimes

    On 422: the fields that failed.

Job

A job. The text fields only on one job.

  • idstring

  • slugstring

  • statusstring

    One of draft, inReview, published, internal, closed, archived.
  • titlestring

  • summarystringsometimes

  • descriptionstringsometimes

  • seoTitlestring or nullsometimes

  • seoDescriptionstring or nullsometimes

  • translationsmap of anysometimes

    Only what differs, by language.

  • employmentTypestring

    One of fullTime, partTime, contract, temporary, internship, apprenticeship, workingStudent.
  • remotestring

    One of onsite, hybrid, remote.
  • departmentIdstring or null

  • locationIdsstring[]

  • salaryany or any or null

  • ownerIdstring or null

  • hiringTeamany[]

  • pipelineIdstring or null

  • publishAtstring or null

  • closeAtstring or null

  • publishedAtstring or null

  • closedAtstring or null

  • createdAtstring or null

  • updatedAtstring or null

Application

  • idstring

  • jobIdstring

  • candidateIdstring

  • stageIdstring

  • stageTypestring or null

  • statusstring

    One of active, rejected, withdrawn, hired.
  • sourcestring

  • sourceDetailobject or null

    Where the candidate came from, when known.

    Fields of sourceDetail
    • utmSourcestring or null

    • utmMediumstring or null

    • utmCampaignstring or null

    • referrerstring or null

  • knockedOutboolean

    Failed a screening rule.

  • fieldsmap of anysometimes

    On one application: the standard fields.

  • answersobject[]sometimes

    On one application: the answers, in the form's order.

    Fields of answers
    • questionIdstring

    • kindstring

      One of text, longText, choice, multiChoice, yesNo, file, date, number.
    • labelstring

      The question as it was asked.

    • valueany

      Text, a list of option ids, a number, yes or no as a boolean, or null.

  • rejectionany or any or nullsometimes

  • withdrawalany or any or nullsometimes

  • cvFileIdstring or nullsometimes

  • fileIdsstring[]sometimes

  • appliedAtstring or null

  • updatedAtstring or null

Candidate

  • idstring

  • firstNamestring

  • lastNamestring

  • emailstring

  • phonestring or null

  • locationstring or null

  • linksany

  • tagsstring[]

  • talentPoolany

  • localestring or null

  • applicationsobject[]sometimes

    On one candidate.

    Fields of applications
    • idstring

    • jobIdstring

    • stageIdstring

    • statusstring

    • appliedAtstring or null

  • createdAtstring or null

  • lastActivityAtstring or null