Endpoint reference
Every endpoint the API offers, grouped by resource. Each one is also an MCP tool with the same input and the same permissions.
Every path below is relative to /api/v1. Lists answer with { data, hasMore, nextCursor }; single resources answer bare.
me
- GET
/meDescribe the account and credential this request is acting as
boards
- GET
/boardsList the boards on this account
- GET
/boards/{boardId}Read one board with its columns and settings
- POST
/boardsCreate a board
- PATCH
/boards/{boardId}Rename a board or make it the active one
- DELETE
/boards/{boardId}Delete a board and everything on it
- PATCH
/boards/{boardId}/settingsChange how one board's cards are filtered and ordered
applications
- GET
/boards/{boardId}/applicationsList the applications on one board
- GET
/applications/{applicationId}Read one application
- POST
/boards/{boardId}/applicationsAdd an application to a board
- PATCH
/applications/{applicationId}Edit the details of one application
- POST
/applications/{applicationId}/moveMove an application to another column, or reorder it within one
- DELETE
/applications/{applicationId}Delete an application
- GET
/applications/{applicationId}/status-historyRead how long an application spent in each column
- POST
/boards/{boardId}/applications/bulk-moveMove many applications into one column at once
- POST
/applications/{applicationId}/resumeRecord which résumé was sent for an application
- DELETE
/applications/{applicationId}/resumeForget which résumé was sent for an application
companies
- GET
/companiesList the companies on this account
- GET
/companies/active-with-jobsList the employers already applied to on the active board
- GET
/companies/{companyId}Read one company
- POST
/companiesRecord a company
- PATCH
/companies/{companyId}Edit a company
- DELETE
/companies/{companyId}Delete a company and every application filed against it
interviews
- GET
/interviewsList interviews
- GET
/interviews/{interviewId}Read one interview
- POST
/applications/{applicationId}/interviewsSchedule an interview on an application
- PATCH
/interviews/{interviewId}Change an interview or record how it went
- DELETE
/interviews/{interviewId}Cancel an interview
contacts
- GET
/contactsList the contacts on this account
- GET
/contacts/linkable-applicationsSearch the applications a contact can be linked to
- GET
/contacts/{contactId}Read one contact with everything they are linked to
- POST
/contactsAdd a contact
- PATCH
/contacts/{contactId}Change a contact
- DELETE
/contacts/{contactId}Delete a contact and every interaction with them
interactions
- GET
/interactionsList logged interactions with contacts
- GET
/interactions/{interactionId}Read one logged interaction
- POST
/contacts/{contactId}/interactionsLog an interaction with a contact
- PATCH
/interactions/{interactionId}Correct a logged interaction
- DELETE
/interactions/{interactionId}Delete a logged interaction
people
- GET
/people/overviewSummarise the networking side of this job search
- GET
/people/analyticsCompare this window of networking against the one before it
insights
- GET
/boards/{boardId}/insightsRead the statistics for one board
table
- GET
/boards/{boardId}/tableRead a board as a flat table of rows
- POST
/boards/{boardId}/table/editsWrite a batch of cell edits to a board
- GET
/boards/{boardId}/table/view-settingsRead the saved table layout for a board
- PUT
/boards/{boardId}/table/view-settingsSave the table layout for a board
exports
- GET
/boards/{boardId}/exportExport a board as spreadsheet rows
imports
- POST
/boards/{boardId}/importsImport a batch of applications onto a board
resumes
- GET
/resumesList the résumés on this account
- GET
/resumes/{resumeId}Read one résumé and get a link to download it
- POST
/resumesUpload a résumé
- DELETE
/resumes/{resumeId}Delete a résumé
profile
- GET
/profileRead the personal details used to fill in application forms
- PATCH
/profileChange the personal details used to fill in application forms
shares
- GET
/sharesList the boards this account has shared with organizations
- POST
/boards/{boardId}/sharesShare a board with an organization
- DELETE
/shares/{shareId}Stop sharing a board with an organization
invitations
- GET
/invitationsList the organization invitations waiting for an answer
- POST
/invitations/{invitationId}/acceptAccept an organization invitation
- POST
/invitations/{invitationId}/declineDecline an organization invitation
coach notes
- GET
/applications/{applicationId}/coach-notesRead the coach notes left on one application
- POST
/applications/{applicationId}/coach-notesLeave feedback on an application
- PATCH
/organizations/{organizationSlug}/coach-notes/{noteId}Reword a note already left on an application
- DELETE
/organizations/{organizationSlug}/coach-notes/{noteId}Take back a note left on an application
organizations
- GET
/organizationsList the organizations this account belongs to
- POST
/organizationsCreate an organization
- GET
/organizations/{organizationSlug}Read one organization
- PATCH
/organizations/{organizationSlug}Change an organization's name, type or website
- DELETE
/organizations/{organizationSlug}Delete an organization
members
- GET
/organizations/{organizationSlug}/membersList the people in an organization
- PATCH
/organizations/{organizationSlug}/members/{memberId}Change a member's role in an organization
- DELETE
/organizations/{organizationSlug}/members/{memberId}Remove somebody from an organization
- POST
/organizations/{organizationSlug}/leaveLeave an organization
organization invitations
- GET
/organizations/{organizationSlug}/invitationsList the invitations an organization has issued
- POST
/organizations/{organizationSlug}/invitationsInvite people to an organization
- POST
/organizations/{organizationSlug}/invitations/{invitationId}/resendReissue an invitation that went unanswered
- DELETE
/organizations/{organizationSlug}/invitations/{invitationId}Withdraw an invitation
cohorts
- GET
/organizations/{organizationSlug}/cohortsList an organization's cohorts
- POST
/organizations/{organizationSlug}/cohortsCreate a cohort
- PATCH
/organizations/{organizationSlug}/cohorts/{cohortId}Rename a cohort, archive it, or reopen it
- DELETE
/organizations/{organizationSlug}/cohorts/{cohortId}Delete a cohort nobody has ever been in
cohort memberships
- GET
/organizations/{organizationSlug}/cohort-membershipsList every stint applicants have spent in cohorts
- POST
/organizations/{organizationSlug}/cohort-membershipsPut an applicant into a cohort
- POST
/organizations/{organizationSlug}/cohort-memberships/{membershipId}/endEnd an applicant's time in a cohort
organization shares
- GET
/organizations/{organizationSlug}/sharesList the boards applicants have shared with an organization
- GET
/organizations/{organizationSlug}/shares/{shareId}Read one shared board and where to read it from
roster
- GET
/organizations/{organizationSlug}/rosterRead the roster of an organization
- GET
/organizations/{organizationSlug}/roster/exportExport the roster as a spreadsheet
organization insights
- GET
/organizations/{organizationSlug}/insightsRead the aggregate figures across an organization
audit events
- GET
/organizations/{organizationSlug}/audit-eventsRead an organization's audit log
billing
- GET
/organizations/{organizationSlug}/billingRead an organization’s seats and subscription
- POST
/organizations/{organizationSlug}/billing/checkout-sessionStart buying seats for an organization
- POST
/organizations/{organizationSlug}/billing/portal-sessionOpen the self-service billing portal for an organization
sandbox
- GET
/sandboxDescribe the sandbox this credential acts on
- POST
/sandbox/resetThrow the sandbox away and plant a fresh copy of the sample data