# Endpoint reference

Every path below is relative to `/api/v1`. Lists answer with `{ data, hasMore, nextCursor }`; single resources answer bare.

## me
- [GET /me](/developers/reference/me.get.md): Describe the account and credential this request is acting as

## boards
- [GET /boards](/developers/reference/boards.list.md): List the boards on this account
- [GET /boards/{boardId}](/developers/reference/boards.get.md): Read one board with its columns and settings
- [POST /boards](/developers/reference/boards.create.md): Create a board
- [PATCH /boards/{boardId}](/developers/reference/boards.update.md): Rename a board or make it the active one
- [DELETE /boards/{boardId}](/developers/reference/boards.delete.md): Delete a board and everything on it
- [PATCH /boards/{boardId}/settings](/developers/reference/boards.update_settings.md): Change how one board's cards are filtered and ordered

## applications
- [GET /boards/{boardId}/applications](/developers/reference/applications.list.md): List the applications on one board
- [GET /applications/{applicationId}](/developers/reference/applications.get.md): Read one application
- [POST /boards/{boardId}/applications](/developers/reference/applications.create.md): Add an application to a board
- [PATCH /applications/{applicationId}](/developers/reference/applications.update.md): Edit the details of one application
- [POST /applications/{applicationId}/move](/developers/reference/applications.move.md): Move an application to another column, or reorder it within one
- [DELETE /applications/{applicationId}](/developers/reference/applications.delete.md): Delete an application
- [GET /applications/{applicationId}/status-history](/developers/reference/applications.list_status_history.md): Read how long an application spent in each column
- [POST /boards/{boardId}/applications/bulk-move](/developers/reference/applications.bulk_move.md): Move many applications into one column at once
- [POST /applications/{applicationId}/resume](/developers/reference/applications.attach_resume.md): Record which résumé was sent for an application
- [DELETE /applications/{applicationId}/resume](/developers/reference/applications.detach_resume.md): Forget which résumé was sent for an application

## companies
- [GET /companies](/developers/reference/companies.list.md): List the companies on this account
- [GET /companies/active-with-jobs](/developers/reference/companies.list_active_with_jobs.md): List the employers already applied to on the active board
- [GET /companies/{companyId}](/developers/reference/companies.get.md): Read one company
- [POST /companies](/developers/reference/companies.create.md): Record a company
- [PATCH /companies/{companyId}](/developers/reference/companies.update.md): Edit a company
- [DELETE /companies/{companyId}](/developers/reference/companies.delete.md): Delete a company and every application filed against it

## interviews
- [GET /interviews](/developers/reference/interviews.list.md): List interviews
- [GET /interviews/{interviewId}](/developers/reference/interviews.get.md): Read one interview
- [POST /applications/{applicationId}/interviews](/developers/reference/interviews.create.md): Schedule an interview on an application
- [PATCH /interviews/{interviewId}](/developers/reference/interviews.update.md): Change an interview or record how it went
- [DELETE /interviews/{interviewId}](/developers/reference/interviews.delete.md): Cancel an interview

## contacts
- [GET /contacts](/developers/reference/contacts.list.md): List the contacts on this account
- [GET /contacts/linkable-applications](/developers/reference/contacts.list_linkable_applications.md): Search the applications a contact can be linked to
- [GET /contacts/{contactId}](/developers/reference/contacts.get.md): Read one contact with everything they are linked to
- [POST /contacts](/developers/reference/contacts.create.md): Add a contact
- [PATCH /contacts/{contactId}](/developers/reference/contacts.update.md): Change a contact
- [DELETE /contacts/{contactId}](/developers/reference/contacts.delete.md): Delete a contact and every interaction with them

## interactions
- [GET /interactions](/developers/reference/interactions.list.md): List logged interactions with contacts
- [GET /interactions/{interactionId}](/developers/reference/interactions.get.md): Read one logged interaction
- [POST /contacts/{contactId}/interactions](/developers/reference/interactions.create.md): Log an interaction with a contact
- [PATCH /interactions/{interactionId}](/developers/reference/interactions.update.md): Correct a logged interaction
- [DELETE /interactions/{interactionId}](/developers/reference/interactions.delete.md): Delete a logged interaction

## people
- [GET /people/overview](/developers/reference/people.get_overview.md): Summarise the networking side of this job search
- [GET /people/analytics](/developers/reference/people.get_analytics.md): Compare this window of networking against the one before it

## insights
- [GET /boards/{boardId}/insights](/developers/reference/insights.get_dashboard.md): Read the statistics for one board

## table
- [GET /boards/{boardId}/table](/developers/reference/table.list_rows.md): Read a board as a flat table of rows
- [POST /boards/{boardId}/table/edits](/developers/reference/table.apply_edits.md): Write a batch of cell edits to a board
- [GET /boards/{boardId}/table/view-settings](/developers/reference/table.get_view_settings.md): Read the saved table layout for a board
- [PUT /boards/{boardId}/table/view-settings](/developers/reference/table.save_view_settings.md): Save the table layout for a board

## exports
- [GET /boards/{boardId}/export](/developers/reference/exports.list_applications.md): Export a board as spreadsheet rows

## imports
- [POST /boards/{boardId}/imports](/developers/reference/imports.create.md): Import a batch of applications onto a board

## resumes
- [GET /resumes](/developers/reference/resumes.list.md): List the résumés on this account
- [GET /resumes/{resumeId}](/developers/reference/resumes.get.md): Read one résumé and get a link to download it
- [POST /resumes](/developers/reference/resumes.create.md): Upload a résumé
- [DELETE /resumes/{resumeId}](/developers/reference/resumes.delete.md): Delete a résumé

## profile
- [GET /profile](/developers/reference/profile.get.md): Read the personal details used to fill in application forms
- [PATCH /profile](/developers/reference/profile.update.md): Change the personal details used to fill in application forms

## shares
- [GET /shares](/developers/reference/shares.list.md): List the boards this account has shared with organizations
- [POST /boards/{boardId}/shares](/developers/reference/shares.create.md): Share a board with an organization
- [DELETE /shares/{shareId}](/developers/reference/shares.delete.md): Stop sharing a board with an organization

## invitations
- [GET /invitations](/developers/reference/invitations.list_mine.md): List the organization invitations waiting for an answer
- [POST /invitations/{invitationId}/accept](/developers/reference/invitations.accept.md): Accept an organization invitation
- [POST /invitations/{invitationId}/decline](/developers/reference/invitations.decline.md): Decline an organization invitation

## coach notes
- [GET /applications/{applicationId}/coach-notes](/developers/reference/coach_notes.list_for_application.md): Read the coach notes left on one application
- [POST /applications/{applicationId}/coach-notes](/developers/reference/coach_notes.create.md): Leave feedback on an application
- [PATCH /organizations/{organizationSlug}/coach-notes/{noteId}](/developers/reference/coach_notes.update.md): Reword a note already left on an application
- [DELETE /organizations/{organizationSlug}/coach-notes/{noteId}](/developers/reference/coach_notes.delete.md): Take back a note left on an application

## organizations
- [GET /organizations](/developers/reference/organizations.list.md): List the organizations this account belongs to
- [POST /organizations](/developers/reference/organizations.create.md): Create an organization
- [GET /organizations/{organizationSlug}](/developers/reference/organizations.get.md): Read one organization
- [PATCH /organizations/{organizationSlug}](/developers/reference/organizations.update.md): Change an organization's name, type or website
- [DELETE /organizations/{organizationSlug}](/developers/reference/organizations.delete.md): Delete an organization

## members
- [GET /organizations/{organizationSlug}/members](/developers/reference/members.list.md): List the people in an organization
- [PATCH /organizations/{organizationSlug}/members/{memberId}](/developers/reference/members.update_role.md): Change a member's role in an organization
- [DELETE /organizations/{organizationSlug}/members/{memberId}](/developers/reference/members.remove.md): Remove somebody from an organization
- [POST /organizations/{organizationSlug}/leave](/developers/reference/members.leave.md): Leave an organization

## organization invitations
- [GET /organizations/{organizationSlug}/invitations](/developers/reference/organization_invitations.list.md): List the invitations an organization has issued
- [POST /organizations/{organizationSlug}/invitations](/developers/reference/organization_invitations.create.md): Invite people to an organization
- [POST /organizations/{organizationSlug}/invitations/{invitationId}/resend](/developers/reference/organization_invitations.resend.md): Reissue an invitation that went unanswered
- [DELETE /organizations/{organizationSlug}/invitations/{invitationId}](/developers/reference/organization_invitations.revoke.md): Withdraw an invitation

## cohorts
- [GET /organizations/{organizationSlug}/cohorts](/developers/reference/cohorts.list.md): List an organization's cohorts
- [POST /organizations/{organizationSlug}/cohorts](/developers/reference/cohorts.create.md): Create a cohort
- [PATCH /organizations/{organizationSlug}/cohorts/{cohortId}](/developers/reference/cohorts.update.md): Rename a cohort, archive it, or reopen it
- [DELETE /organizations/{organizationSlug}/cohorts/{cohortId}](/developers/reference/cohorts.delete.md): Delete a cohort nobody has ever been in

## cohort memberships
- [GET /organizations/{organizationSlug}/cohort-memberships](/developers/reference/cohort_memberships.list.md): List every stint applicants have spent in cohorts
- [POST /organizations/{organizationSlug}/cohort-memberships](/developers/reference/cohort_memberships.create.md): Put an applicant into a cohort
- [POST /organizations/{organizationSlug}/cohort-memberships/{membershipId}/end](/developers/reference/cohort_memberships.end.md): End an applicant's time in a cohort

## organization shares
- [GET /organizations/{organizationSlug}/shares](/developers/reference/organization_shares.list.md): List the boards applicants have shared with an organization
- [GET /organizations/{organizationSlug}/shares/{shareId}](/developers/reference/organization_shares.get.md): Read one shared board and where to read it from

## roster
- [GET /organizations/{organizationSlug}/roster](/developers/reference/roster.list.md): Read the roster of an organization
- [GET /organizations/{organizationSlug}/roster/export](/developers/reference/roster.export.md): Export the roster as a spreadsheet

## organization insights
- [GET /organizations/{organizationSlug}/insights](/developers/reference/organization_insights.get_dashboard.md): Read the aggregate figures across an organization

## audit events
- [GET /organizations/{organizationSlug}/audit-events](/developers/reference/audit_events.list.md): Read an organization's audit log

## billing
- [GET /organizations/{organizationSlug}/billing](/developers/reference/billing.get.md): Read an organization’s seats and subscription
- [POST /organizations/{organizationSlug}/billing/checkout-session](/developers/reference/billing.create_checkout_session.md): Start buying seats for an organization
- [POST /organizations/{organizationSlug}/billing/portal-session](/developers/reference/billing.create_portal_session.md): Open the self-service billing portal for an organization

## sandbox
- [GET /sandbox](/developers/reference/sandbox.get.md): Describe the sandbox this credential acts on
- [POST /sandbox/reset](/developers/reference/sandbox.reset.md): Throw the sandbox away and plant a fresh copy of the sample data