# Talkpush API Docs Documentation > Documentation for Talkpush API Docs ## Guides: Documentation - [Getting Started with Talkpush API Docs](https://talkpush-apidocs.readme.io/docs/getting-started.md): With the Talkpush APIs you can instantly plug your lead source into out platform to enjoy the benefits of Talkpush. You can also synchronize your existing HR / Recruitment technology stack… ## API Reference: Talkpush API - Leads API - [Retrieve a list of leads matching your search criterias](https://talkpush-apidocs.readme.io/reference/get_campaign-invitations.md): This API endpoint will enable you to search through your lead database programatically with the same criterias than you would use on the recruiter's leads page. You can execute 2 kinds of search:… - [Update a lead's details](https://talkpush-apidocs.readme.io/reference/patch_campaign-invitations-id.md): Updates the details of an existing lead. In addition to the fields on the candidate, this endpoint accepts an optional `candidate.labels` object to add or remove labels on the candidate in a single… - [Create a new lead](https://talkpush-apidocs.readme.io/reference/post_campaigns-id-campaign-invitations.md): This endpoint can be used to insert a new lead in the campaign given in url - [Complete the interview for a candidate aplication](https://talkpush-apidocs.readme.io/reference/post_campaign-invitations-id-interview.md): With this endpoint a candidate can complete the campaign's interview. DISCLAIMER - Only text, short_text and multiple choice question types supported. No audio or image question type… - [Create a comment for a lead](https://talkpush-apidocs.readme.io/reference/post_campaign-invitations-id-comments.md): With this endpoint you can add comments to the lead's profile (the campaign invitation). - [Change lead's status](https://talkpush-apidocs.readme.io/reference/put_campaign-invitations-id-status.md): Update the lead status - [Move a lead to a different campaign](https://talkpush-apidocs.readme.io/reference/put_campaign-invitations-id-move.md): With this endpoint you can move a lead (the campaign invitation) between different campaigns. E.g. a candidate applied for Front end developer but her profile actually suits the fullstack developer… - [Reassign a lead to another user](https://talkpush-apidocs.readme.io/reference/put_campaign-invitations-id-reassign.md): Inside the Talkpush CRM Leads can be assigned to recruiters, this allows user to easily find their leads. With this endpoint you can change the assigned recruiter of a lead. - [Attach a document to a lead](https://talkpush-apidocs.readme.io/reference/put_campaign-invitations-id-documents.md): With this endpoint you can attach a document to a lead. A document tag Id or Name are needed to attach the file to a lead. - Messaging API - [Retrieve all the available Quick Reply templates](https://talkpush-apidocs.readme.io/reference/get_messaging-quick-replies.md): This endpoint let's you retrieve all the available Quick Reply templates, view their content, title and the ID which you will require in order to send a message via the /messaging endpoint. - [Send a quick reply template to a lead.](https://talkpush-apidocs.readme.io/reference/post_messaging-messages.md): This endpoint lets you send a quick reply template to a given lead, via a determined channel. The ID of a quick reply template can be retrieved either inside the CRM's Quick Reply Management Screen… - Campaigns API - [Retrieve all active campaigns of the account](https://talkpush-apidocs.readme.io/reference/get_campaigns.md): This endpoint returns a list of all the active campaigns in the company account. The campaigns can be filtered by type parameter (optional), **if no type is defined, by the default, the result will… - [Create a new campaign inside your Talkpush account](https://talkpush-apidocs.readme.io/reference/post_campaigns.md): This endpoint lets you create a new campaign inside Talkpush. Not all the information required to set up a fully operational campaign can be provided via the API. Permission settings, questions,… - [Retrieve all archive campaigns of the account](https://talkpush-apidocs.readme.io/reference/get_campaigns-archive.md): This endpoint returns a list with all the archive campaigns in the company account. - [Retrieve details of active campaigns that match the search criteria](https://talkpush-apidocs.readme.io/reference/get_campaigns-search-criteria.md): This endpoint returns a list of active campaigns that match the search criteria in the company account. - [Retrieve details of a specific active campaign](https://talkpush-apidocs.readme.io/reference/get_campaigns-id.md): This endpoint returns a specific campaigns details in the company account. - [Update a campaign inside your Talkpush account](https://talkpush-apidocs.readme.io/reference/put_campaigns-id.md): This endpoint lets you update an exixting campaign inside Talkpush. Not all the information required to update the campaign. Permission settings, questions, message, smart filters and notifications… - [Get questions for a specific campaign](https://talkpush-apidocs.readme.io/reference/get_campaigns-id-questions.md): This endpoint let's you retrieve all the questions that are associated to a campaign for which you provide the ID in the path. DISCLAIMER - Only text, short_text and multiple choice types… - [Retrieve all the folders that are associated to a campaign](https://talkpush-apidocs.readme.io/reference/get_campaigns-id-folders.md): This endpoint let's you see what folders are associated to the campaign for which you provide the ID in the path - [Archive an existing campaign](https://talkpush-apidocs.readme.io/reference/put_campaigns-id-archive.md): This endpoint let's you archive a campaign for which you provide the ID in the path - [Activate an archived campaign](https://talkpush-apidocs.readme.io/reference/put_campaigns-id-activate.md): This endpoint let's you activate a archived campaign for which you provide the ID in the path - [Associate a campaign with a custom folder](https://talkpush-apidocs.readme.io/reference/post_campaigns-campaign-id-folders-folder-id.md): In order for custom folders to become available in a given campaign they need to be associated with the campaign. This is not necessary for custom folders that are enabled as default folders, which… - Folders API - [Retrieve all the available folders on the company account](https://talkpush-apidocs.readme.io/reference/get_company-folders.md): This endpoint let's you retrieve all the available folders on the company account and shows whether these are default folders. This is useful for example if you want to display the them inside your… - [Create custom folders](https://talkpush-apidocs.readme.io/reference/post_company-folders.md): This endpoint let's you create custom folders in the company account. A common scenario for this endpoint would be to create a custom folder whenever you create a new recruitment process step inside… - Document Tags API - [Retrieve all the available document tags(templates) on the company account](https://talkpush-apidocs.readme.io/reference/get_document-tags.md): This endpoint let's you retrieve all the available document tags(templates) on the company account. - Calls API - [Retrieve a list of calls within a date range](https://talkpush-apidocs.readme.io/reference/get_calls.md): This endpoint returns a paginated list of calls within the specified date range. Each call record includes the associated app_id. The start_date and end_date parameters are required and must be in… - Candidate Attributes API - [List all candidate attribute definitions](https://talkpush-apidocs.readme.io/reference/get_company-candidate-attributes.md): Returns every attribute definition for the company, including default (system) and custom attributes, ordered by `name`. Use this to drive integrations and to discover keys for the leads `others`… - [Create a custom candidate attribute](https://talkpush-apidocs.readme.io/reference/post_company-candidate-attributes.md): Creates a new **custom** attribute definition. It becomes available in the UI immediately and is writable on leads through the `others` field using the persisted key (custom keys are stored with an… - Agents API - [Retrieve a list of agents](https://talkpush-apidocs.readme.io/reference/get_agents.md): Returns a paginated list of AI agents configured in the company account, ordered by most recently updated. Supports optional filtering by category, provider, and active status. - [Retrieve details of a specific agent](https://talkpush-apidocs.readme.io/reference/get_agents-id.md): Returns the full detail of a single agent, including its prompt, provider info, linked question set, and the complete data extractions configuration. - [Update an existing agent](https://talkpush-apidocs.readme.io/reference/put_agents-id.md): Updates an agent's configuration. All fields are optional — only the fields provided will be changed. **Note:** if `data_extractions` is included, it **replaces** the existing extractions entirely… - [Delete an agent](https://talkpush-apidocs.readme.io/reference/delete_agents-id.md): Permanently deletes the agent identified by `id`. On success, returns HTTP 204 with no response body. - [Retrieve a list of calls for a specific agent](https://talkpush-apidocs.readme.io/reference/get_agents-agent-id-calls.md): Returns a paginated list of call records handled by the given agent, ordered by most recent first. Each record includes the associated application (candidate / campaign invitation) context, extracted… - [Retrieve the changelog for a specific agent](https://talkpush-apidocs.readme.io/reference/get_agents-agent-id-changelog.md): Returns a paginated list of audit log entries for the given agent, ordered by most recent first. Each entry describes a single create, update, or destroy event — who made the change, when, and what… - [Create a new agent](https://talkpush-apidocs.readme.io/reference/post_agents.md): Creates a new AI agent configuration. On success, returns HTTP 201 with the newly created agent details. The `data_extractions` field in the request uses the candidate attribute **key** string (e.g.… - Labels API - [List company labels](https://talkpush-apidocs.readme.io/reference/get_company-labels.md): Returns labels configured for the company account. Results are paginated and can be filtered by name. The system-reserved `Deleted` label is excluded. **Pagination:** Use `page` and `per_page`… - [Create a label](https://talkpush-apidocs.readme.io/reference/post_company-labels.md): Creates a new label for the company. The label becomes available in the UI immediately and can be assigned to candidates via `PATCH /campaign_invitations/{id}`. **Duplicate prevention:** If a label… - Message Templates API - [List message templates](https://talkpush-apidocs.readme.io/reference/get_messaging-templates.md): Returns all Message Templates for the company, excluding system-internal `StatusReason` sub-type templates. Content is always returned in Handlebars format (`{{token_name}}`), even when the… - [Create a message template](https://talkpush-apidocs.readme.io/reference/post_messaging-templates.md): Creates a new Message Template for the company. The template is immediately available in the UI and can be referenced by autoflows. **Content format:** The `content` field must use Handlebars syntax… - [Update a message template](https://talkpush-apidocs.readme.io/reference/patch_messaging-templates-id.md): Partially updates an existing Message Template. Only the fields provided in the request body are changed; omitted fields are left unchanged. **Content validation:** If `content` is provided, all… - Tokens API - [List available message tokens](https://talkpush-apidocs.readme.io/reference/get_messaging-tokens.md): Returns all tokens that can be used inside a Message Template's `content` field. The list includes: - **System tokens** — built-in reserved words (e.g. `candidate_name`, `job_title`,… - Movement Reasons API - [List movement (shortlist & reject) reasons](https://talkpush-apidocs.readme.io/reference/get_movement-reasons.md): Returns the company's configured **Shortlist Reasons** and **Reject Reasons** — the values recruiters can pick when moving a candidate to a shortlisted or rejected state. Soft-deleted reasons are… - Managers API - [List company managers](https://talkpush-apidocs.readme.io/reference/get_managers.md): Returns the active managers (platform users) for the authenticated company. Deactivated managers are excluded. Results are paginated and can be filtered by role and name. **Pagination:** Use `page`… ## API Reference: Integrations API - Requisition Management System - [Callback endpoint](https://talkpush-apidocs.readme.io/reference/post_rms-callback.md): This API endpoint will be used to receive callbacks from RMS when a job requisition is created.