# Pinpoint API Reference API

> Pinpoint API Reference API on Apizie: 68 endpoints (List Applications, Create Application, Fetch Application, Update Application, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/open-data:pinpoint/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:pinpoint`
- Category: Open Data
- Status: byok
- Source: https://pinpointhq.com
- Page: https://www.apizie.tech/api/open-data/pinpoint
- OpenAPI: https://www.apizie.tech/api/open-data/pinpoint/openapi.json

Applicant tracking software that’s ready for anything. Get more control with branded careers sites, flexible templates, tailored workflows, beautiful reports, and an easier hiring process—not just for your candidates,…

## Endpoints

### List Applications
`GET https://www.apizie.tech/v1/open-data:pinpoint/applications-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| extra_fields[applications] | array | no | Include fields that are not always needed, or perhaps computationally expensive |
| fields[applications] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| filters[locale] | string | no | Filter records that were submitted under that locale. |
| filter[created_at][gt] | string | no | Filter records with a creation time greater than this value. |
| filter[created_at][lt] | string | no | Filter records with a creation time less than this value. |
| filter[internal_candidate] | boolean | no | Filter records based on whether they're marked as an internal candidate |
| filter[job_id] | string | no | Filter records by their job ID |
| filter[job_visibility] | array | no | Filter records by the visibility of the job that they belong to. To ensure backwards compatibility, applications belonging to confidential… |
| filter[stage_basic_type] | array | no | Filter records based on their stage basic type |
| filter[stage_id] | string | no | Filter records by their stage ID. |
| filter[updated_at][gt] | string | no | Filter records with a last update time greater than this value. |
| filter[updated_at][lt] | string | no | Filter records with a last update time less than this value. |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Application
`POST https://www.apizie.tech/v1/open-data:pinpoint/applications-create-new-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Application
`GET https://www.apizie.tech/v1/open-data:pinpoint/applications-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| fields[applications] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| extra_fields[applications] | array | no | Include fields that are not always needed, or perhaps computationally expensive |

### Update Application
`POST https://www.apizie.tech/v1/open-data:pinpoint/applications-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### List Comments
`GET https://www.apizie.tech/v1/open-data:pinpoint/comments-list-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[comments] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| filter[created_at][gt] | string | no | Filter records with a creation time greater than this value. |
| filter[created_at][lt] | string | no | Filter records with a creation time less than this value. |
| filter[updated_at][gt] | string | no | Filter records with a last update time greater than this value. |
| filter[updated_at][lt] | string | no | Filter records with a last update time less than this value. |
| filter[commentable_id] | integer | no | Filter records by their commentable ID |
| filter[commentable_type] | array | no | Filter records based on whether they are for applications or job seekers |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Comment
`POST https://www.apizie.tech/v1/open-data:pinpoint/comments-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Comment
`GET https://www.apizie.tech/v1/open-data:pinpoint/comments-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| fields[comments] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### List Custom Attributes
`GET https://www.apizie.tech/v1/open-data:pinpoint/custom-attributes-list-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[custom_attributes] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| filter[created_at][gt] | string | no | Filter records with a creation time greater than this value. |
| filter[created_at][lt] | string | no | Filter records with a creation time less than this value. |
| filter[updated_at][gt] | string | no | Filter records with a last update time greater than this value. |
| filter[updated_at][lt] | string | no | Filter records with a last update time less than this value. |
| filter[custom_attributable_id] | integer | no | Filter records by their custom_attributable ID |
| filter[custom_attributable_type] | array | no | Filter records by the type of the associated resource |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Custom Attribute
`POST https://www.apizie.tech/v1/open-data:pinpoint/custom-attributes-create-new-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Custom Attribute
`GET https://www.apizie.tech/v1/open-data:pinpoint/custom-attributes-get-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[custom_attributes] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |

### Update Custom Attribute
`POST https://www.apizie.tech/v1/open-data:pinpoint/custom-attributes-update-attribute-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Delete Custom Attribute
`POST https://www.apizie.tech/v1/open-data:pinpoint/custom-attributes-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List Custom Fields
`GET https://www.apizie.tech/v1/open-data:pinpoint/custom-fields-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[custom_fields] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Custom Field
`POST https://www.apizie.tech/v1/open-data:pinpoint/custom-fields-create-new-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Custom Field
`GET https://www.apizie.tech/v1/open-data:pinpoint/custom-fields-get-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[custom_fields] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### Update Custom Field
`POST https://www.apizie.tech/v1/open-data:pinpoint/custom-fields-update-field-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Delete Custom Field
`POST https://www.apizie.tech/v1/open-data:pinpoint/custom-fields-delete-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List Departments
`GET https://www.apizie.tech/v1/open-data:pinpoint/departments-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[departments] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Department
`POST https://www.apizie.tech/v1/open-data:pinpoint/departments-create-new-department` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Department
`GET https://www.apizie.tech/v1/open-data:pinpoint/departments-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[departments] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### Update Department
`POST https://www.apizie.tech/v1/open-data:pinpoint/departments-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Delete Department
`POST https://www.apizie.tech/v1/open-data:pinpoint/departments-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List Divisions
`GET https://www.apizie.tech/v1/open-data:pinpoint/divisions-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[divisions] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Division
`POST https://www.apizie.tech/v1/open-data:pinpoint/divisions-create-division` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Division
`GET https://www.apizie.tech/v1/open-data:pinpoint/divisions-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[divisions] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### Update Division
`POST https://www.apizie.tech/v1/open-data:pinpoint/divisions-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Delete Division
`POST https://www.apizie.tech/v1/open-data:pinpoint/divisions-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List equality monitoring categories
`GET https://www.apizie.tech/v1/open-data:pinpoint/equality-monitoring-categories-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| filter[created_at][gt] | string | no | Filter records with a creation time greater than this value. |
| filter[created_at][lt] | string | no | Filter records with a creation time less than this value. |
| fields[equality_monitoring_categories] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| filter[enabled] | boolean | no | Filter records based on whether they're marked as enabled |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |
| filter[updated_at][gt] | string | no | Filter records with a last update time greater than this value. |
| filter[updated_at][lt] | string | no | Filter records with a last update time less than this value. |

### Fetch equality monitoring category
`GET https://www.apizie.tech/v1/open-data:pinpoint/equality-monitoring-categories-get-category-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| fields[equality_monitoring_categories] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### List Interviews
`GET https://www.apizie.tech/v1/open-data:pinpoint/interviews-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[interviews] | array | no | [Include only specified fields of Interview in response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| filter[created_at][gt] | string | no | Filter records with a creation time greater than this value. |
| filter[created_at][lt] | string | no | Filter records with a creation time less than this value. |
| filter[interviewable_id] | integer | no | Filter records by interviewable ID |
| filter[interviewable_type] | string | no | Filter records based on whether they are for applications or job seekers |
| filter[job_visibility] | array | no | Filter records by the visibility of the job that they belong to. By default, interviews associated with applications for confidential jobs… |
| filter[start_at][gt] | string | no | Filter records with a start at time greater than this value. |
| filter[start_at][lt] | string | no | Filter records with a start at time less than this value. |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |

### Fetch Interview
`GET https://www.apizie.tech/v1/open-data:pinpoint/interviews-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[interviews] | array | no | [Include only specified fields of Interview in response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |

### List Hiring Workflows
`GET https://www.apizie.tech/v1/open-data:pinpoint/hiring-workflows-list-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |

### Fetch Hiring Workflow
`GET https://www.apizie.tech/v1/open-data:pinpoint/hiring-workflows-get-workflow-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List Jobs
`GET https://www.apizie.tech/v1/open-data:pinpoint/jobs-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| filter[created_at][gt] | string | no | Filter records with a creation time greater than this value. |
| filter[created_at][lt] | string | no | Filter records with a creation time less than this value. |
| filter[department_id] | integer | no | Filter by department ID |
| filter[department_name] | string | no | Filter by department name |
| filter[division_id] | integer | no | Filter by division ID |
| filter[division_name] | string | no | Filter by division name |
| filter[employment_type] | array | no | Filter by employment type |
| filter[hiring_manager_user_id] | integer | no | Filter by hiring manager user ID |
| filter[location_id] | integer | no | Filter by location ID |
| filter[location_name] | string | no | Filter by location name |
| filter[recruitment_manager_user_id] | integer | no | Filter by recruitment manager user ID |
| filter[remote] | boolean | no | Filter by whether the role is remote |
| filter[search] | string | no | Perform a keyword search on the job title |
| filter[status] | array | no | Filter by status |
| filter[structure_custom_group_one_id] | integer | no | Filter by custom structure group ID |
| filter[structure_custom_group_one_name] | string | no | Filter by custom structure group name |
| filter[visibility] | array | no | Filter by whether this job is confidential, internal, external. To ensure backwards compatibility, confidential jobs are excluded from… |
| filter[workplace_type] | array | no | Filter by workplace type |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| locale | string | no | Return translatable fields in the locale specified. `null` will be returned for a field if a translation has not been provided. |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Job
`POST https://www.apizie.tech/v1/open-data:pinpoint/jobs-create-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Job
`GET https://www.apizie.tech/v1/open-data:pinpoint/jobs-get-job-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| locale | string | no | Return translatable fields in the locale specified. `null` will be returned for a field if a translation has not been provided. |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| fields[jobs] | array | no | [Include only specified fields of Job in response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### Update Job
`POST https://www.apizie.tech/v1/open-data:pinpoint/jobs-update-job-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Delete Job
`POST https://www.apizie.tech/v1/open-data:pinpoint/jobs-delete-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List Job Seekers
`GET https://www.apizie.tech/v1/open-data:pinpoint/job-seekers-list-job-seekers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| extra_fields[job_seekers] | array | no | Include fields that are not always needed, and perhaps computationally expensive |
| fields[job_seekers] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Fetch Job Seeker
`GET https://www.apizie.tech/v1/open-data:pinpoint/job-seekers-get-job-seeker-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| extra_fields[job_seekers] | array | no | Include fields that are not always needed, and perhaps computationally expensive |
| fields[job_seekers] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |

### List Locations
`GET https://www.apizie.tech/v1/open-data:pinpoint/locations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[locations] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Location
`POST https://www.apizie.tech/v1/open-data:pinpoint/locations-create-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Location
`GET https://www.apizie.tech/v1/open-data:pinpoint/locations-get-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[locations] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### Update Location
`POST https://www.apizie.tech/v1/open-data:pinpoint/locations-update-location-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Delete Location
`POST https://www.apizie.tech/v1/open-data:pinpoint/locations-remove-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List Onboarding Applications
`GET https://www.apizie.tech/v1/open-data:pinpoint/onboarding-applications-list-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| filter[created_at][gt] | string | no | Filter records with a creation time greater than this value. |
| filter[created_at][lt] | string | no | Filter records with a creation time less than this value. |
| fields[onboarding_applications] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| filter[start_at][gt] | string | no | Filter records with a start at time greater than this value. |
| filter[start_at][lt] | string | no | Filter records with a start at time less than this value. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |
| filter[updated_at][gt] | string | no | Filter records with a last update time greater than this value. |
| filter[updated_at][lt] | string | no | Filter records with a last update time less than this value. |

### Fetch Onboarding Application
`GET https://www.apizie.tech/v1/open-data:pinpoint/onboarding-applications-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[onboarding_applications] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |

### List Requisition Templates
`GET https://www.apizie.tech/v1/open-data:pinpoint/requisition-templates-list-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[requisition_templates] | array | no | [Include only specified fields of Requisition template in response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| filter[created_at][gt] | string | no | Filter records with a creation time greater than this value. |
| filter[created_at][lt] | string | no | Filter records with a creation time less than this value. |
| filter[updated_at][gt] | string | no | Filter records with a last update time greater than this value. |
| filter[updated_at][lt] | string | no | Filter records with a last update time less than this value. |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Fetch Requisition Template
`GET https://www.apizie.tech/v1/open-data:pinpoint/requisition-templates-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| fields[requisition_templates] | array | no | [Include only specified fields of Requisition template in response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### List Requisitions
`GET https://www.apizie.tech/v1/open-data:pinpoint/requisitions-list-requisitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[requisitions] | array | no | [Include only specified fields of Requisition in response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| filter[created_at][gt] | string | no | Filter records with a creation time greater than this value. |
| filter[created_at][lt] | string | no | Filter records with a creation time less than this value. |
| filter[updated_at][gt] | string | no | Filter records with a last update time greater than this value. |
| filter[updated_at][lt] | string | no | Filter records with a last update time less than this value. |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Requisition
`POST https://www.apizie.tech/v1/open-data:pinpoint/requisitions-create-new-requisition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Requisition
`GET https://www.apizie.tech/v1/open-data:pinpoint/requisitions-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| fields[requisitions] | array | no | [Include only specified fields of Requisition in response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### Update Requisition
`POST https://www.apizie.tech/v1/open-data:pinpoint/requisitions-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Delete Requisition
`POST https://www.apizie.tech/v1/open-data:pinpoint/requisitions-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List Structure Custom Group Ones
`GET https://www.apizie.tech/v1/open-data:pinpoint/structure-custom-group-ones-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[structure_custom_group_ones] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| sort | array | no | [Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`… |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Structure Custom Group One
`POST https://www.apizie.tech/v1/open-data:pinpoint/structure-custom-group-ones-create-new-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Structure Custom Group One
`GET https://www.apizie.tech/v1/open-data:pinpoint/structure-custom-group-ones-get-one` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[structure_custom_group_ones] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### Update Structure Custom Group One
`POST https://www.apizie.tech/v1/open-data:pinpoint/structure-custom-group-ones-update-one` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Delete Structure Custom Group One
`POST https://www.apizie.tech/v1/open-data:pinpoint/structure-custom-group-ones-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List Structure Links
`GET https://www.apizie.tech/v1/open-data:pinpoint/structure-links-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[structure_links] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| extra_fields[structure_links] | array | no | Include fields that are not always needed, or perhaps computationally expensive |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create Structure Link
`POST https://www.apizie.tech/v1/open-data:pinpoint/structure-links-create-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch Structure Links
`GET https://www.apizie.tech/v1/open-data:pinpoint/structure-links-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[structure_links] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| extra_fields[structure_links] | array | no | Include fields that are not always needed, or perhaps computationally expensive |
| include | array | no | [Include related resources](https://jsonapi.org/format/#fetching-includes) |

### Update Structure Link
`POST https://www.apizie.tech/v1/open-data:pinpoint/structure-links-update-link-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Delete Structure Link
`POST https://www.apizie.tech/v1/open-data:pinpoint/structure-links-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

### List users
`GET https://www.apizie.tech/v1/open-data:pinpoint/users-list-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| fields[users] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |
| filter[employee] | boolean | no | Filter records based on whether the user is an employee of your company |
| page[number] | integer | no | The page number of records to return |
| page[size] | integer | no | The number of records to return. |
| stats[total] | string | no | Include the total number of matched records within the meta key of the response object. |

### Create User
`POST https://www.apizie.tech/v1/open-data:pinpoint/users-create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| body | object | yes | JSON request body |

### Fetch users
`GET https://www.apizie.tech/v1/open-data:pinpoint/users-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |
| fields[users] | array | no | [Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets) |

### Delete User
`POST https://www.apizie.tech/v1/open-data:pinpoint/users-remove-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.pinpointhq.com |
| id | string | yes | ID of the resource |

## Example
```
curl "https://www.apizie.tech/v1/open-data:pinpoint/applications-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Pinpoint API Reference API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/open-data:pinpoint/applications-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Pinpoint API Reference API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Pinpoint API Reference itself also needs your own key from {subdomain}.pinpointhq.com.

### Can AI agents use the Pinpoint API Reference API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:pinpoint.

### What is the status of the Pinpoint API Reference API?
Needs your own provider key (bring your own key)