# Spott Documentation

## Docs

- [Get application pipeline stages](https://api-docs.spott.io/api-reference/application-pipeline/get-application-pipeline-stages.md): Retrieve all Application Stages. Returns an ordered list of pipeline stages with their labels.
- [Bulk update applications](https://api-docs.spott.io/api-reference/applications/bulk-update-applications.md): Update up to 100 applications in one request. Each application update sets the target stage and numeric position.
- [Create a rejection for an application](https://api-docs.spott.io/api-reference/applications/create-a-rejection-for-an-application.md): Create a rejection for an application by its ID.
- [Create an application](https://api-docs.spott.io/api-reference/applications/create-an-application.md): Creates a new application. Link a candidate to either a job or directly to a client for speculative applications.
- [Delete an application](https://api-docs.spott.io/api-reference/applications/delete-an-application.md): Deletes the application with the specified ID.
- [Get application presentations](https://api-docs.spott.io/api-reference/applications/get-application-presentations.md): Retrieve available exported candidate presentations for a specific application.
- [Get applications by candidate ID](https://api-docs.spott.io/api-reference/applications/get-applications-by-candidate-id.md): Retrieve all applications for a specific Candidate, including both standard applications (linked to jobs) and speculative applications (linked directly to clients).
- [Get applications by job ID](https://api-docs.spott.io/api-reference/applications/get-applications-by-job-id.md): Retrieve all applications associated with a specific job. Includes candidate information, application status, and stage progression details.
- [List applications](https://api-docs.spott.io/api-reference/applications/list-applications.md): Returns a list of applications. Uses cursor pagination.
- [Move application to stage](https://api-docs.spott.io/api-reference/applications/move-application-to-stage.md): Move an application to a different pipeline stage within the same job. Optionally set a status and specify the position relative to other applications in the target stage.
- [Retrieve an application](https://api-docs.spott.io/api-reference/applications/retrieve-an-application.md): Retrieves the application with the specified ID. Includes candidate details, job information, stage, and activity history.
- [Assign temporary attachments to records](https://api-docs.spott.io/api-reference/attachments/assign-temporary-attachments-to-records.md): Assigns previously uploaded temporary attachments to one or more records (candidate, company, or vacancy). Each attachment can be assigned a specific type and optionally renamed. At least one of candidateId, companyId, or vacancyId must be provided.
- [Get attachment download URL](https://api-docs.spott.io/api-reference/attachments/get-attachment-download-url.md): Returns a time-limited signed URL for downloading the attachment. The URL expires after 1 hour.
- [Upload temporary attachments](https://api-docs.spott.io/api-reference/attachments/upload-temporary-attachments.md): Upload one or more files as temporary attachments. These attachments are stored temporarily and must be assigned to a record (candidate, company, or vacancy) using the assign endpoint before they become permanent.
- [Link candidates to a list](https://api-docs.spott.io/api-reference/candidate-lists/link-candidates-to-a-list.md): Link a set of candidates to a specific candidate list. Specify candidate IDs to add to the list.
- [Unlink candidates from a list](https://api-docs.spott.io/api-reference/candidate-lists/unlink-candidates-from-a-list.md): Unlink a set of candidates from a specific candidate list. Specify candidate IDs to remove from the list.
- [Create candidate](https://api-docs.spott.io/api-reference/candidate-portal/create-candidate.md): Create a new candidate from CV and form details. Used by the candidate portal when a candidate submits their application.
- [Get existing candidate](https://api-docs.spott.io/api-reference/candidate-portal/get-existing-candidate.md): Get basic details on existing candidate to pre-fill the candidate update form. Returns email addresses, phone numbers, social media links, and name information.
- [Update candidate](https://api-docs.spott.io/api-reference/candidate-portal/update-candidate.md): Update existing candidate from CV and form details. Used by the candidate portal when an existing candidate updates their profile.
- [Bulk create candidates from CV](https://api-docs.spott.io/api-reference/candidates/bulk-create-candidates-from-cv.md): Automatically create multiple candidates from uploaded CV files without human review.
- [Create a candidate](https://api-docs.spott.io/api-reference/candidates/create-a-candidate.md): Creates a new candidate. Provide the candidate details directly. Use the unsupervised endpoint for raw CV uploads.
- [Create candidate from CV](https://api-docs.spott.io/api-reference/candidates/create-candidate-from-cv.md): Automatically create a candidate from a single uploaded CV file without human review.
- [Create certification](https://api-docs.spott.io/api-reference/candidates/create-certification.md): Create a new certification record for a specific candidate.
- [Create contact identifier](https://api-docs.spott.io/api-reference/candidates/create-contact-identifier.md): Create a new contact identifier (email, phone number, LinkedIn URL) for a specific candidate.
- [Create education](https://api-docs.spott.io/api-reference/candidates/create-education.md): Create a new education record for a specific candidate.
- [Create work experience](https://api-docs.spott.io/api-reference/candidates/create-work-experience.md): Create a new work experience record for a specific candidate.
- [Delete a candidate](https://api-docs.spott.io/api-reference/candidates/delete-a-candidate.md): Deletes the candidate with the specified ID.
- [Delete certification](https://api-docs.spott.io/api-reference/candidates/delete-certification.md): Delete a certification record.
- [Delete education](https://api-docs.spott.io/api-reference/candidates/delete-education.md): Delete an education record.
- [Delete work experience](https://api-docs.spott.io/api-reference/candidates/delete-work-experience.md): Delete a work experience record.
- [Get certifications](https://api-docs.spott.io/api-reference/candidates/get-certifications.md): Retrieve all certification records for a specific candidate.
- [Get contact identifiers](https://api-docs.spott.io/api-reference/candidates/get-contact-identifiers.md): Retrieve all contact identifiers (emails, phone numbers, LinkedIn URL) for a specific candidate. If the candidate is linked to any client contacts, their contact identifiers will also be included in the response.
- [Get education](https://api-docs.spott.io/api-reference/candidates/get-education.md): Retrieve all education records for a specific candidate including degrees, institutions, and graduation dates.
- [Get work experiences](https://api-docs.spott.io/api-reference/candidates/get-work-experiences.md): Retrieve all work experiences for a specific candidate including job titles, companies, dates, and experience statistics.
- [List candidates](https://api-docs.spott.io/api-reference/candidates/list-candidates.md): Returns a list of candidates. Uses cursor pagination.
- [Replace certifications](https://api-docs.spott.io/api-reference/candidates/replace-certifications.md): Replace all certification records for a specific candidate.
- [Replace education](https://api-docs.spott.io/api-reference/candidates/replace-education.md): Replace all education records for a specific candidate.
- [Replace work experiences](https://api-docs.spott.io/api-reference/candidates/replace-work-experiences.md): Replace all work experience records for a specific candidate.
- [Retrieve a candidate](https://api-docs.spott.io/api-reference/candidates/retrieve-a-candidate.md): Retrieves the candidate with the specified ID. Includes personal details, contact information, and any linked client contacts.
- [Search candidates](https://api-docs.spott.io/api-reference/candidates/search-candidates.md): Retrieve a paginated list of candidates filtered by supported predefined candidate fields and candidate custom attributes.
- [Update a candidate](https://api-docs.spott.io/api-reference/candidates/update-a-candidate.md): Updates the candidate with the specified ID. Only provided fields are updated. You can update personal details, contact information, and other candidate attributes.
- [Update certification](https://api-docs.spott.io/api-reference/candidates/update-certification.md): Update an existing certification record.
- [Update education](https://api-docs.spott.io/api-reference/candidates/update-education.md): Update an existing education record.
- [Update work experience](https://api-docs.spott.io/api-reference/candidates/update-work-experience.md): Update an existing work experience record.
- [Link client contacts to a list](https://api-docs.spott.io/api-reference/client-contact-lists/link-client-contacts-to-a-list.md): Link a set of client contacts to a specific client contact list. Specify client contact IDs to add to the list.
- [Unlink client contacts from a list](https://api-docs.spott.io/api-reference/client-contact-lists/unlink-client-contacts-from-a-list.md): Unlink a set of client contacts from a specific client contact list. Specify client contact IDs to remove from the list.
- [Create client contact](https://api-docs.spott.io/api-reference/client-contacts/create-client-contact.md): Create a new client contact for a specific client. Includes personal information such as name, emails, phone numbers, role, and department.
- [Get client contact by candidate ID](https://api-docs.spott.io/api-reference/client-contacts/get-client-contact-by-candidate-id.md): Retrieve detailed information about a Contact including their personal details, company associations, contact information, interaction history, and custom attributes.
- [Get client contacts](https://api-docs.spott.io/api-reference/client-contacts/get-client-contacts.md): Returns a list of client contacts. Uses cursor pagination.
- [Update client contact](https://api-docs.spott.io/api-reference/client-contacts/update-client-contact.md): Update an existing client contact. All fields are optional - only provided fields will be updated.
- [Retrieve a client hierarchy](https://api-docs.spott.io/api-reference/client-hierarchies/retrieve-a-client-hierarchy.md): Retrieves the client hierarchy with the specified ID. Returns the full hierarchy tree rooted at the requested hierarchy ID, including each client in the tree and its relation to its parent.
- [Link clients to a list](https://api-docs.spott.io/api-reference/client-lists/link-clients-to-a-list.md): Link a set of clients to a specific client list. Specify client IDs to add to the list.
- [Unlink clients from a list](https://api-docs.spott.io/api-reference/client-lists/unlink-clients-from-a-list.md): Unlink a set of clients from a specific client list. Specify client IDs to remove from the list.
- [Create a client](https://api-docs.spott.io/api-reference/clients/create-a-client.md): Creates a new client. Includes company information such as name, description, industry, size, and location details.
- [Delete a client](https://api-docs.spott.io/api-reference/clients/delete-a-client.md): Deletes the client with the specified ID. The underlying company is not deleted. Only the client record and client-owned relations are removed.
- [List clients](https://api-docs.spott.io/api-reference/clients/list-clients.md): Returns a list of clients. Uses cursor pagination.
- [Retrieve a client](https://api-docs.spott.io/api-reference/clients/retrieve-a-client.md): Retrieves the client with the specified ID. Includes company details, contacts, industry, size, funding, locations, hierarchies, and custom attributes.
- [Search clients](https://api-docs.spott.io/api-reference/clients/search-clients.md): Returns a list of clients that match the provided filters. Supports a flexible filter set and returns paginated results with basic client information.
- [Update a client](https://api-docs.spott.io/api-reference/clients/update-a-client.md): Updates the client with the specified ID. Client-level fields update the client record. Company-level fields nested under `company` update the underlying company and are rejected with 403 when the client is linked to a global company.
- [Delete a company](https://api-docs.spott.io/api-reference/companies/delete-a-company.md): Deletes the company with the specified ID. Only tenant-owned companies can be deleted. Global companies are shared across tenants and cannot be removed.
- [Search companies](https://api-docs.spott.io/api-reference/companies/search-companies.md): Returns a list of companies that match the provided filters. Supports a flexible filter set and returns paginated results with company details.
- [Update a company](https://api-docs.spott.io/api-reference/companies/update-a-company.md): Updates the company with the specified ID. Only tenant-owned companies can be updated. Global companies are shared across tenants and cannot be changed.
- [Create consent](https://api-docs.spott.io/api-reference/consents/create-consent.md): Create a new consent record for a candidate. Requires consent details including purpose, legal basis, and validity period.
- [Delete consent](https://api-docs.spott.io/api-reference/consents/delete-consent.md): Delete a consent record by its ID.
- [Get consents](https://api-docs.spott.io/api-reference/consents/get-consents.md): Retrieve the latest consent per purpose for a given candidate. Returns all active consents associated with the candidate ID.
- [Update consent](https://api-docs.spott.io/api-reference/consents/update-consent.md): Partially update an existing consent record. Only the provided fields will be updated.
- [List candidate custom attribute definitions](https://api-docs.spott.io/api-reference/custom-attributes/list-candidate-custom-attribute-definitions.md): Returns a list of candidate custom attribute definitions. Custom attributes allow you to store additional structured data on candidate records.
- [List client custom attribute definitions](https://api-docs.spott.io/api-reference/custom-attributes/list-client-custom-attribute-definitions.md): Returns a list of client custom attribute definitions. Custom attributes allow you to store additional structured data on client records.
- [List contact custom attribute definitions](https://api-docs.spott.io/api-reference/custom-attributes/list-contact-custom-attribute-definitions.md): Returns a list of contact custom attribute definitions. Custom attributes allow you to store additional structured data on contact records.
- [List job custom attribute definitions](https://api-docs.spott.io/api-reference/custom-attributes/list-job-custom-attribute-definitions.md): Returns a list of job custom attribute definitions. Custom attributes allow you to store additional structured data on job records.
- [List placement custom attribute definitions](https://api-docs.spott.io/api-reference/custom-attributes/list-placement-custom-attribute-definitions.md): Returns a list of placement custom attribute definitions. Placement attribute definitions are scoped to a placement template. Each item includes its templateId, and the list can be narrowed to a single template with the optional templateId query parameter.
- [Retrieve a candidate custom attribute definition](https://api-docs.spott.io/api-reference/custom-attributes/retrieve-a-candidate-custom-attribute-definition.md): Retrieves the candidate custom attribute definition with the specified ID.
- [Retrieve a client custom attribute definition](https://api-docs.spott.io/api-reference/custom-attributes/retrieve-a-client-custom-attribute-definition.md): Retrieves the client custom attribute definition with the specified ID.
- [Retrieve a contact custom attribute definition](https://api-docs.spott.io/api-reference/custom-attributes/retrieve-a-contact-custom-attribute-definition.md): Retrieves the contact custom attribute definition with the specified ID.
- [Retrieve a job custom attribute definition](https://api-docs.spott.io/api-reference/custom-attributes/retrieve-a-job-custom-attribute-definition.md): Retrieves the job custom attribute definition with the specified ID.
- [Retrieve a placement custom attribute definition](https://api-docs.spott.io/api-reference/custom-attributes/retrieve-a-placement-custom-attribute-definition.md): Retrieves the placement custom attribute definition with the specified ID.
- [Update custom attribute values for a candidate](https://api-docs.spott.io/api-reference/custom-attributes/update-custom-attribute-values-for-a-candidate.md): Update one or more custom attribute values for a specific candidate. Provide an array of attribute definition IDs and their new values.
- [Update custom attribute values for a client](https://api-docs.spott.io/api-reference/custom-attributes/update-custom-attribute-values-for-a-client.md): Update one or more custom attribute values for a specific client. Provide an array of attribute definition IDs and their new values.
- [Update custom attribute values for a contact](https://api-docs.spott.io/api-reference/custom-attributes/update-custom-attribute-values-for-a-contact.md): Update one or more custom attribute values for a specific contact. Provide an array of attribute definition IDs and their new values.
- [Update custom attribute values for a job](https://api-docs.spott.io/api-reference/custom-attributes/update-custom-attribute-values-for-a-job.md): Update one or more custom attribute values for a specific job. Provide an array of attribute definition IDs and their new values.
- [Get job description for job](https://api-docs.spott.io/api-reference/job-descriptions/get-job-description-for-job.md): Retrieve the job description associated with a specific job, including the external job title and description content.
- [Update job description](https://api-docs.spott.io/api-reference/job-descriptions/update-job-description.md): Update the job description for a specific job. Allows setting the external job title and the description content.
- [Get job portal branding](https://api-docs.spott.io/api-reference/job-portal/get-job-portal-branding.md): Get the branding for the job portal.
- [Get posted job details](https://api-docs.spott.io/api-reference/job-portal/get-posted-job-details.md): Get details on an single publicly posted job for a tenant.
- [Get posted jobs](https://api-docs.spott.io/api-reference/job-portal/get-posted-jobs.md): Get all publicly posted jobs for a tenant.
- [Submit job posting application](https://api-docs.spott.io/api-reference/job-portal/submit-job-posting-application.md): Submit an application for a publicly posted job. The application includes candidate information and CV attachment.
- [Create a job](https://api-docs.spott.io/api-reference/jobs/create-a-job.md): Creates a new job. Requires a company ID and job details such as status, title, and description.
- [Get job pipeline stages](https://api-docs.spott.io/api-reference/jobs/get-job-pipeline-stages.md): Retrieve a list of all pipeline stages configured for jobs. Each stage represents a step in the hiring workflow (e.g., Applied, Screening, Interview, Offer).
- [List jobs](https://api-docs.spott.io/api-reference/jobs/list-jobs.md): Returns a list of jobs. Uses cursor pagination.
- [Retrieve a job](https://api-docs.spott.io/api-reference/jobs/retrieve-a-job.md): Retrieves the job with the specified ID. Includes custom attributes, job details, and metadata.
- [Search jobs](https://api-docs.spott.io/api-reference/jobs/search-jobs.md): Returns a list of jobs that match the provided filters. Supports a flexible filter set and returns paginated results with full job details.
- [Update a job](https://api-docs.spott.io/api-reference/jobs/update-a-job.md): Updates the job with the specified ID. You can update job status, title, description, and other job properties.
- [List meetings](https://api-docs.spott.io/api-reference/meetings/list-meetings.md): Returns a list of meetings. Uses cursor pagination.
- [Create note label](https://api-docs.spott.io/api-reference/note-labels/create-note-label.md): Create a new note label with a name and color. Note labels are used to categorize notes within the system.
- [Delete note label](https://api-docs.spott.io/api-reference/note-labels/delete-note-label.md): Delete a note label by its ID. This will remove the label from all associated notes.
- [Get note labels](https://api-docs.spott.io/api-reference/note-labels/get-note-labels.md): Retrieve a paginated list of note labels. Note labels are used to categorize and organize notes within the system.
- [Update note label](https://api-docs.spott.io/api-reference/note-labels/update-note-label.md): Update an existing note label by its ID. You can update the name, color, or both.
- [Create a note](https://api-docs.spott.io/api-reference/notes/create-a-note.md): Creates a new note. You can optionally link the note to candidates, jobs, applications, companies, or client contacts.
- [List notes](https://api-docs.spott.io/api-reference/notes/list-notes.md): Returns a list of notes. Uses cursor pagination.
- [Update a note](https://api-docs.spott.io/api-reference/notes/update-a-note.md): Updates the note with the specified ID.
- [Create an opportunity](https://api-docs.spott.io/api-reference/opportunities/create-an-opportunity.md): Creates a new opportunity. Provide the company, pipeline stage, estimated value, and other opportunity details.
- [Get opportunity pipeline stages](https://api-docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages.md): Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).
- [List opportunities](https://api-docs.spott.io/api-reference/opportunities/list-opportunities.md): Returns a list of opportunities. Uses cursor pagination.
- [Retrieve an opportunity](https://api-docs.spott.io/api-reference/opportunities/retrieve-an-opportunity.md): Retrieves the opportunity with the specified ID. Includes all custom attributes.
- [Update an opportunity](https://api-docs.spott.io/api-reference/opportunities/update-an-opportunity.md): Updates the opportunity with the specified ID. You can update stage, close date, and other opportunity properties.
- [Enroll a recipient in an outreach sequence](https://api-docs.spott.io/api-reference/outreach-sequences/enroll-a-recipient-in-an-outreach-sequence.md): Create a new outreach sequence run, enrolling a candidate (or a client contact tied to a candidate) in the sequence.
- [List outreach sequences](https://api-docs.spott.io/api-reference/outreach-sequences/list-outreach-sequences.md): Returns a list of outreach sequences. Uses cursor pagination.
- [List placements](https://api-docs.spott.io/api-reference/placements/list-placements.md): Returns a list of placements. Supports pagination, filtering by company, sort options, and applied filters. Returns candidate, company, job, fee, and placement metadata.
- [Retrieve a placement](https://api-docs.spott.io/api-reference/placements/retrieve-a-placement.md): Retrieves the placement with the specified ID. Includes custom attribute values, fee splits, and placement metadata.
- [Update a placement](https://api-docs.spott.io/api-reference/placements/update-a-placement.md): Updates the placement with the specified ID. You can update dates, template, placed-by user, and custom attribute values.
- [Search people](https://api-docs.spott.io/api-reference/search-people/search-people.md): Returns a list of people that match the provided filters. Searches across candidates and client contacts. You can search by full name, email address, or phone number. Results use fuzzy matching for partial matches and minor typos, ranked by relevance.
- [Create a skill](https://api-docs.spott.io/api-reference/skills/create-a-skill.md): Creates a new skill. Provide a name and color. The skill can then be linked to candidates.
- [Create multiple skills](https://api-docs.spott.io/api-reference/skills/create-multiple-skills.md): Create multiple skills in a single request. Each skill requires a name and color.
- [Delete a skill](https://api-docs.spott.io/api-reference/skills/delete-a-skill.md): Deletes the skill with the specified ID. This also removes all candidate-skill links.
- [Link candidates to a skill](https://api-docs.spott.io/api-reference/skills/link-candidates-to-a-skill.md): Link a set of candidates to a specific skill. Candidates already linked to the skill will be skipped.
- [List skills](https://api-docs.spott.io/api-reference/skills/list-skills.md): Returns a list of skills. Uses cursor pagination.
- [Unlink candidates from a skill](https://api-docs.spott.io/api-reference/skills/unlink-candidates-from-a-skill.md): Unlink a set of candidates from a specific skill. Candidates not linked to the skill will be skipped.
- [Update a skill](https://api-docs.spott.io/api-reference/skills/update-a-skill.md): Updates the skill with the specified ID. Only provided fields are updated.
- [Create task](https://api-docs.spott.io/api-reference/tasks/create-task.md): Create a new task with optional due date, assignee, and links to entities (candidates, vacancies, clients, etc.).
- [Get transcript](https://api-docs.spott.io/api-reference/transcripts/get-transcript.md): Retrieve a transcript by its ID. Returns the full transcript content including all segments with speaker information and timestamps.
- [List users](https://api-docs.spott.io/api-reference/users/list-users.md): Returns a list of users. By default, only active users are returned. Set includeDeactivated=true to include deactivated users in the response.
- [List users alias](https://api-docs.spott.io/api-reference/users/list-users-alias.md): Backward-compatible alias for the private user list endpoint.
- [Use Spott in ChatGPT](https://api-docs.spott.io/chatgpt.md): Connect Spott to ChatGPT to run your full recruiting workflow from chat — search candidates, manage pipelines, schedule interviews, send emails, and place candidates without leaving the conversation.
- [Use Spott in Claude](https://api-docs.spott.io/claude.md): Connect Spott to Claude to run your full recruiting workflow from chat — search candidates, manage pipelines, schedule interviews, send emails, and place candidates without leaving the conversation.
- [Getting started](https://api-docs.spott.io/pages/getting-started.md)

## OpenAPI Specs

- [openapi-webhooks](https://api-docs.spott.io/openapi-webhooks.json)
- [openapi-private](https://api-docs.spott.io/openapi-private.json)
- [openapi-public](https://api-docs.spott.io/openapi-public.json)