> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pinpoint

> How to set up the Pinpoint connector, plus the actions and events that are available.

![Pinpoint](https://stackone-logos.com/api/pinpoint/filled/svg)

v1.2.1[See changelog](https://docs.stackone.com/connectors/pinpoint/changelog.md)

[91 actions](#actions) · [17 events](#events) · 1 auth method

ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/pinpoint/guides/connector-profile/api-key.md)
>
> Uses an API key created in Pinpoint. Access is limited to the permissions assigned to the key.

Optionally, configure receiving Events for Pinpoint into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/pinpoint/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/pinpoint/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

91 actions

ActionDescription

List Access Groups`pinpoint_list_access_groups`

Retrieve a list of access groups that define user permissions and roles within the platform.

Get Access Group`pinpoint_get_access_group`

Fetch detailed information about a specific access group by ID.

Get Answer`pinpoint_get_answer`

Fetch a specific answer by ID.

Create Answer`pinpoint_create_answer`

Submit a candidate's answer to a screening question on an application or job seeker profile.

Update Answer`pinpoint_update_answer`

Modify a candidate's previously submitted answer to update the response value.

Delete Answer`pinpoint_delete_answer`

Remove a candidate's answer from the system.

List Applications`pinpoint_list_applications`

Retrieve a paginated list of job applications with optional filtering by candidate email, job, stage, and other criteria...

Get Application`pinpoint_get_application`

Fetch detailed information about a specific application by ID, including candidate details, current stage, job informati...

Create Application`pinpoint_create_application`

Create a new job application for a candidate, submitting their profile to a specific job posting with required informati...

Update Application`pinpoint_update_application`

Update an existing application's details, move it to a different stage in the hiring workflow, or modify application met...

Delete Application`pinpoint_delete_application`

Remove an application from the system.

List Candidate Surveys`pinpoint_list_candidate_surveys`

Retrieve candidate survey responses to analyze post-interview feedback, experience ratings, and candidate satisfaction d...

Get Candidate Survey`pinpoint_get_candidate_survey`

Fetch individual candidate survey response to review detailed feedback and experience ratings from a specific candidate.

List Candidates`pinpoint_list_candidates`

Retrieve a paginated list of candidate profiles with optional filtering and related resources.

Get Candidate`pinpoint_get_candidate`

Fetch detailed information about a specific candidate by ID.

Update Candidate`pinpoint_update_candidate`

Update candidate profile information including contact details, skills, and custom attributes.

List Comments`pinpoint_list_comments`

Retrieve comments and notes on applications or candidates for team collaboration and feedback synchronization across hir...

Get Comment`pinpoint_get_comment`

Fetch a specific comment by ID to retrieve detailed feedback, interviewer notes, or team discussion threads.

Create Comment`pinpoint_create_comment`

Add a comment or note to an application or candidate profile to record interviewer feedback, hiring team discussions, or...

List Custom Fields`pinpoint_list_custom_fields`

Retrieve custom field definitions to discover organization-specific data fields configured for applications, jobs, candi...

Get Custom Field`pinpoint_get_custom_field`

Fetch detailed information about a specific custom field including its schema, validation rules, and applicable resource...

Create Custom Field`pinpoint_create_custom_field`

Define a new custom field to track organization-specific information on applications, jobs, candidates, or offers with c...

Update Custom Field`pinpoint_update_custom_field`

Modify custom field configuration including validation rules, display options, and field metadata to adapt to changing b...

Delete Custom Field`pinpoint_delete_custom_field`

Remove a custom field definition from the system, which will also delete all associated custom attribute values.

List Custom Attributes`pinpoint_list_custom_attributes`

Retrieve custom attribute values set on resource instances to access organization-specific data stored on applications,...

Create Custom Attribute`pinpoint_create_custom_attribute`

Set a custom attribute value on a resource instance to store organization-specific data on applications, jobs, or candid...

Get Custom Attribute`pinpoint_get_custom_attribute`

Fetch a specific custom attribute by ID to retrieve its current value and related metadata.

Update Custom Attribute`pinpoint_update_custom_attribute`

Update the value of an existing custom attribute. Only value fields may be changed; reassociation is not supported.

Delete Custom Attribute`pinpoint_delete_custom_attribute`

Remove a custom attribute value from a resource instance to clear organization-specific data that is no longer needed.

List Hiring Workflows`pinpoint_list_hiring_workflows`

Retrieve hiring workflow templates to display available workflows when creating jobs and understand standard hiring proc...

Get Hiring Workflow`pinpoint_get_hiring_workflow`

Fetch detailed information about a specific hiring workflow including all stages, requirements, and configuration settin...

List Interviews`pinpoint_list_interviews`

Retrieve a list of scheduled interviews with participant information for calendar synchronization and scheduling coordin...

Get Interview`pinpoint_get_interview`

Fetch detailed information about a specific interview including date, time, participants, location, and associated appli...

Update Interview`pinpoint_update_interview`

Update an interview's summary in HTML format. Only the summary field is supported for updates.

List Job Seekers`pinpoint_list_job_seekers`

Retrieve a list of job seeker profiles from the passive candidate pool for proactive talent sourcing and pipeline buildi...

Get Job Seeker`pinpoint_get_job_seeker`

Fetch detailed information about a specific job seeker including profile, preferences, and passive candidate pool status...

List Jobs`pinpoint_list_jobs`

Retrieve a paginated list of job postings with optional filters for status, department, location, and other criteria to...

Get Job`pinpoint_get_job`

Fetch detailed information about a specific job posting including description, requirements, hiring workflow, department...

Create Job`pinpoint_create_job`

Create a new job posting with title, description, status, hiring workflow, and organizational structure links for depart...

Update Job`pinpoint_update_job`

Update an existing job posting.

Delete Job`pinpoint_delete_job`

Delete a job posting.

List Onboarding Applications`pinpoint_list_onboarding_applications`

Retrieve a list of onboarding applications to track new hire onboarding progress, task completion, and document collecti...

Get Onboarding Application`pinpoint_get_onboarding_application`

Fetch detailed information about a specific onboarding application including tasks, documents, and completion status for...

List Positions`pinpoint_list_positions`

Retrieve a list of positions

Fetch Position`pinpoint_get_position`

Retrieve a single position by ID

List Structured Sections`pinpoint_list_structured_sections`

Retrieve structured section definitions for onboarding workflows to understand form layouts and data collection requirem...

Get Structured Section`pinpoint_get_structured_section`

Fetch detailed information about a specific structured section to understand its form layout, field definitions, and dat...

Create Structured Section Response`pinpoint_create_structured_section_response`

Submit a response to a structured onboarding section to record candidate or new hire data in onboarding forms and workfl...

Update Structured Section Response`pinpoint_update_structured_section_response`

Modify a structured onboarding section response to update new hire information or correct onboarding form submissions.

Delete Structured Section Response`pinpoint_delete_structured_section_response`

Remove a structured onboarding section response to clear incorrect form submissions or reset onboarding data.

List Departments`pinpoint_list_departments`

Retrieve a list of company departments for organizing job postings and managing organizational hierarchy in the ATS.

Get Department`pinpoint_get_department`

Fetch detailed information about a specific department including name, hierarchy, and associated job postings.

Create Department`pinpoint_create_department`

Create a new department to organize job postings and manage organizational hierarchy in the ATS.

Update Department`pinpoint_update_department`

Update department details such as name or organizational hierarchy to sync changes from external HR systems.

Delete Department`pinpoint_delete_department`

Remove a department from the system to archive outdated department records from the organizational structure.

List Divisions`pinpoint_list_divisions`

Retrieve a list of company divisions for high-level organizational structure reporting and hierarchy management.

Get Division`pinpoint_get_division`

Fetch detailed information about a specific division including its departments and organizational position within the co...

Create Division`pinpoint_create_division`

Create a new division for high-level organizational structure reporting and hierarchy management.

Update Division`pinpoint_update_division`

Update division details such as name or organizational position to sync changes from external HR systems.

Delete Division`pinpoint_delete_division`

Remove a division from the system to archive outdated division records from the organizational structure.

List Equality Monitoring Categories`pinpoint_list_equality_monitoring_categories`

Retrieve all equality monitoring categories configured in the system for tracking diversity and inclusion data.

Get Equality Monitoring Category`pinpoint_get_equality_monitoring_category`

Retrieve detailed information about a specific equality monitoring category including its enabled status and associated...

List Locations`pinpoint_list_locations`

Retrieve a list of company office locations for filtering job postings and displaying available work locations to candid...

Get Location`pinpoint_get_location`

Fetch detailed information about a specific office location including address, city, state, country, and timezone inform...

Create Location`pinpoint_create_location`

Create a new office location for filtering job postings and displaying available work locations to candidates.

Update Location`pinpoint_update_location`

Update location details such as address, contact information, or office status to sync changes from external HR systems.

Delete Location`pinpoint_delete_location`

Remove a location from the system to archive closed offices or outdated location records from the organizational structu...

List Structure Links`pinpoint_list_structure_links`

Retrieve structure links that associate departments with locations to map job postings to specific organizational combin...

Get Structure Link`pinpoint_get_structure_link`

Fetch a specific structure link to understand the department-location association for a particular organizational unit.

Create Structure Link`pinpoint_create_structure_link`

Create a new department-location association to set up organizational structure for new offices or department expansions...

Update Structure Link`pinpoint_update_structure_link`

Update a structure link. Only the accepts\_speculative\_applications attribute can be modified.

Delete Structure Link`pinpoint_delete_structure_link`

Permanently delete a structure link from the system to remove department-location associations.

List Structure Custom Group Ones`pinpoint_list_structure_custom_group_ones`

Retrieve a list of custom organizational groups for structuring teams and departments.

Create Structure Custom Group One`pinpoint_create_structure_custom_group_one`

Create a new custom organizational group for structuring teams and departments.

Get Structure Custom Group One`pinpoint_get_structure_custom_group_one`

Retrieve a specific custom organizational group by ID.

Update Structure Custom Group One`pinpoint_update_structure_custom_group_one`

Update an existing custom organizational group.

Delete Structure Custom Group One`pinpoint_delete_structure_custom_group_one`

Delete a custom organizational group.

List Questions`pinpoint_list_questions`

Retrieve all screening questions used across jobs and applications to manage candidate qualification criteria and assess...

List Requisition Templates`pinpoint_list_requisition_templates`

Retrieve a list of requisition templates used for creating job requisitions.

Get Requisition Template`pinpoint_get_requisition_template`

Retrieve a specific requisition template by ID with related fields.

List Requisitions`pinpoint_list_requisitions`

Retrieve a list of hiring requisitions with approval workflows and headcount tracking.

Get Requisition`pinpoint_get_requisition`

Retrieve a specific requisition by ID with related resources and custom details.

Update Requisition`pinpoint_update_requisition`

Archive a requisition by setting archived status to true.

Delete Requisition`pinpoint_delete_requisition`

Permanently delete a requisition by ID.

Create Requisition`pinpoint_create_requisition`

Create a new hiring requisition with approval workflows and headcount tracking.

List Scorecards`pinpoint_list_scorecards`

Retrieve a list of interview scorecards to access evaluation criteria, rating scales, and interviewer feedback templates...

Get Scorecard`pinpoint_get_scorecard`

Fetch detailed information about a specific scorecard including evaluation criteria, rating scales, and feedback questio...

List Users`pinpoint_list_users`

Retrieve a list of platform users to sync hiring team members, permissions, and user access across integrated systems.

Get User`pinpoint_get_user`

Fetch detailed information about a specific user including profile, role, permissions, and department assignments.

Create User`pinpoint_create_user`

Create a new user in the system. As a bare minimum, first\_name, last\_name, and email must be supplied. user\_type must al...

Delete User`pinpoint_delete_user`

Permanently delete a user from the system to remove access and archive user records.

## Events

Tags

Select all
|
Clear

Applications

Background Checks

Candidates

Interviews

Jobs

Offers

Onboarding

Requisitions

Users

Webhooks

No tags found

17 events

EventDescriptionTags

Active Check`pinpoint_active_check`Manual setup

Acknowledges any webhook delivery that is not a recognized Pinpoint event with a 200 response and no emitted event.

Webhooks

New Application`pinpoint_webhook_application_created`Manual setup

Fires when a candidate submits a new application to a job. Pinpoint event `application_created`.

ApplicationsWebhooks

Application Stage Changed`pinpoint_webhook_application_stage_changed`Manual setup

Fires when an application moves to another hiring stage. Pinpoint event `application_stage_changed`.

ApplicationsWebhooks

Offer Accepted`pinpoint_webhook_application_offer_accepted`Manual setup

Fires when a candidate accepts an offer. Pinpoint event `application_offer_accepted`.

OffersWebhooks

Applicant Hired`pinpoint_webhook_application_hired`Manual setup

Fires when an applicant is marked as hired. Pinpoint event `application_hired`.

ApplicationsWebhooks

Application Moved`pinpoint_webhook_application_moved`Manual setup

Fires when an application is moved to another job. Pinpoint event `application_moved`.

ApplicationsWebhooks

User Created`pinpoint_webhook_user_created_on_company`Manual setup

Fires when a user is added to the Pinpoint company. Pinpoint event `user_created_on_company`.

UsersWebhooks

Job Created`pinpoint_webhook_job_created`Manual setup

Fires when a job is created. Pinpoint event `job_created`.

JobsWebhooks

Job Updated`pinpoint_webhook_job_updated`Manual setup

Fires when a job is updated. Pinpoint event `job_updated`.

JobsWebhooks

Job Deleted`pinpoint_webhook_job_deleted`Manual setup

Fires when a job is deleted. Pinpoint event `job_deleted`.

JobsWebhooks

Onboarding Workflow Completed`pinpoint_webhook_onboarding_workflow_completed`Manual setup

Fires when an onboarding workflow is completed. Pinpoint event `onboarding_workflow_completed`.

OnboardingWebhooks

Onboarding Completed`pinpoint_webhook_onboarding_completed`Manual setup

Fires when onboarding is completed for an application. Pinpoint event `onboarding_completed`.

OnboardingWebhooks

Talent Pipeline Candidate Created`pinpoint_webhook_job_seeker_created`Manual setup

Fires when a candidate is added to the talent pipeline. Pinpoint event `job_seeker_created`.

CandidatesWebhooks

Requisition Created`pinpoint_webhook_requisition_created`Manual setup

Fires when a requisition is created. Pinpoint event `requisition_created`.

RequisitionsWebhooks

Requisition Approved`pinpoint_webhook_requisition_approved`Manual setup

Fires when a requisition is approved. Pinpoint event `requisition_approved`.

RequisitionsWebhooks

Interview Scheduled`pinpoint_webhook_interview_scheduled`Manual setup

Fires when an interview is scheduled. Pinpoint event `interview_scheduled`.

InterviewsWebhooks

Background Check Completed`pinpoint_webhook_background_check_completed`Manual setup

Fires when a background check is completed. Pinpoint event `background_check_completed`.

Background ChecksWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.