API Reference

Answers
Applications
Candidates
Comments
Custom Attributes
Custom Fields
Departments
Divisions
Equality Monitoring Categories
- List equality monitoring categoriesget
- Fetch equality monitoring categoryget
Hiring Workflows
- List Hiring Workflowsget
- Fetch Hiring Workflowget
Interviews
- List Interviewsget
- Fetch Interviewget
Jobs
Job Seekers
- List Job Seekersget
- Fetch Job Seekerget
Locations
Onboarding Applications
- List Onboarding Applicationsget
- Fetch Onboarding Applicationget
Positions
- List Positionsget
- Fetch Positionget
Requisitions
Requisition Templates
- List Requisition Templatesget
- Fetch Requisition Templateget
Structure Custom Group Ones
Structure Links
Structured Sections
- List Structured Sectionsget
- Fetch Structured Sectionsget
Structured Section Responses
Users

API Reference

Answers
Applications
Candidates
Comments
Custom Attributes
Custom Fields
Departments
Divisions
Equality Monitoring Categories
- List equality monitoring categoriesget
- Fetch equality monitoring categoryget
Hiring Workflows
- List Hiring Workflowsget
- Fetch Hiring Workflowget
Interviews
- List Interviewsget
- Fetch Interviewget
Jobs
Job Seekers
- List Job Seekersget
- Fetch Job Seekerget
Locations
Onboarding Applications
- List Onboarding Applicationsget
- Fetch Onboarding Applicationget
Positions
- List Positionsget
- Fetch Positionget
Requisitions
Requisition Templates
- List Requisition Templatesget
- Fetch Requisition Templateget
Structure Custom Group Ones
Structure Links
Structured Sections
- List Structured Sectionsget
- Fetch Structured Sectionsget
Structured Section Responses
Users

List Positions

get https://{subdomain}.pinpointhq.com/api/v1/positions

URL Expired

The URL for this request expired after 30 days.

Query Params

filter[created_at][gt]

date-time

Filter records with a creation time greater than this value.

filter[created_at][lt]

date-time

Filter records with a creation time less than this value.

fields[positions]

array of strings

Include only specified fields in the response.

include

array of strings

Include related resources.

sort

array of strings

Sort records according to one or more criteria.

You should not include both ascending id and descending -id fields the same time.

page[number]

integer

Defaults to 1

The page number of records to return

page[size]

integer

0 to 1000

Defaults to 100

The number of records to return.

stats[total]

string

Include the total number of matched records within the meta key of the response object.

filter[updated_at][gt]

date-time

Filter records with a last update time greater than this value.

filter[updated_at][lt]

date-time

Filter records with a last update time less than this value.

Responses

Response body

json

Response body

object

errors

array of objects

required

errors*

object

links

object

Has additional fields

status

string

The HTTP status code applicable to this problem, expressed as a string value.

code

string

An application-specific error code, expressed as a string value.

title

string

A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

Response body

object

errors

array of objects

required

errors*

object

links

object

Has additional fields

status

string

The HTTP status code applicable to this problem, expressed as a string value.

code

string

An application-specific error code, expressed as a string value.

title

string

A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

Response body

object

errors

array of objects

required

errors*

object

links

object

Has additional fields

status

string

The HTTP status code applicable to this problem, expressed as a string value.

code

string

An application-specific error code, expressed as a string value.

title

string

A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

Response body

object

errors

array of objects

required

errors*

object

links

object

Has additional fields

status

string

The HTTP status code applicable to this problem, expressed as a string value.

code

string

An application-specific error code, expressed as a string value.

title

string

A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

Response body

object

errors

array of objects

required

errors*

object

links

object

Has additional fields

status

string

The HTTP status code applicable to this problem, expressed as a string value.

code

string

An application-specific error code, expressed as a string value.

title

string

A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

meta

object

Non-standard meta-information that can not be represented as an attribute or relationship.

Has additional fields

Updated 2 days ago

Fetch Onboarding Application

Fetch Position

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://your-subdomain.pinpointhq.com/api/v1/positions?page[number]=1&page[size]=100' \
3
     --header 'accept: application/vnd.api+json'


xxxxxxxxxx
41
}
1
{
2
  "data": [
3
    {
4
      "id": "1000310",
5
      "type": "positions",
6
      "attributes": {
7
        "id": "1",
8
        "archived_at": "2019-01-01T00:00:00+00:00",
9
        "discarded_at": "2019-01-01T00:00:00+00:00",
10
        "identifier": "4295211",
11
        "name": "Legal Director",
12
        "parent_position_id": null,
13
        "created_at": "2019-01-01T00:00:00+00:00",
14
        "updated_at": "2019-01-01T00:00:00+00:00"
15
      },
16
      "relationships": {
17
        "child_positions": {
18
          "meta": {
19
            "included": false
20
          }
21
        },
22
        "current_position_opening": {
23
          "meta": {
24
            "included": false
25
          }

Updated 2 days ago

Fetch Onboarding Application

Fetch Position

API Reference
Answers
Delete Answerdelete
Update Answerput
Fetch Answerget
Create Answerpost
Applications
Update Applicationput
Fetch Applicationget
Create Applicationpost
List Applicationsget
Candidates
Update Candidateput
Fetch Candidateget
List Candidatesget
Candidate Surveys
Fetch Candidate Surveyget
List Candidate Surveysget
Comments
Fetch Commentget
Create Commentpost
List Commentsget
Custom Attributes
Delete Custom Attributedelete
Update Custom Attributeput
Fetch Custom Attributeget
Create Custom Attributepost
List Custom Attributesget
Custom Fields
Delete Custom Fielddelete
Update Custom Fieldput
Fetch Custom Fieldget
Create Custom Fieldpost
List Custom Fieldsget
Departments
Delete Departmentdelete
Update Departmentput
Fetch Departmentget
Create Departmentpost
List Departmentsget
Divisions
Delete Divisiondelete
Update Divisionput
Fetch Divisionget
Create Divisionpost
List Divisionsget
Equality Monitoring Categories
Fetch equality monitoring categoryget
List equality monitoring categoriesget
Hiring Workflows
Fetch Hiring Workflowget
List Hiring Workflowsget
Interviews
Fetch Interviewget
List Interviewsget
Jobs
Delete Jobdelete
Update Jobput
Fetch Jobget
Create Jobpost
List Jobsget
Job Seekers
Fetch Job Seekerget
List Job Seekersget
Locations
Delete Locationdelete
Update Locationput
Fetch Locationget
Create Locationpost
List Locationsget
Onboarding Applications
Fetch Onboarding Applicationget
List Onboarding Applicationsget
Positions
Fetch Positionget
List Positionsget
Requisitions
Delete Requisitiondelete
Update Requisitionput
Fetch Requisitionget
Create Requisitionpost
List Requisitionsget
Requisition Templates
Fetch Requisition Templateget
List Requisition Templatesget
Structure Custom Group Ones
Delete Structure Custom Group Onedelete
Update Structure Custom Group Oneput
Fetch Structure Custom Group Oneget
Create Structure Custom Group Onepost
List Structure Custom Group Onesget
Structure Links
Delete Structure Linkdelete
Update Structure Linkput
Fetch Structure Linksget
Create Structure Linkpost
List Structure Linksget
Structured Sections
Fetch Structured Sectionsget
List Structured Sectionsget
Structured Section Responses
Delete Structured Section Responsedelete
Update Structured Section Responseput
Create Structured Section Responsepost
Users
Delete Userdelete
Fetch usersget
Create Userpost
List usersget

API Reference
Answers
Delete Answerdelete
Update Answerput
Fetch Answerget
Create Answerpost
Applications
Update Applicationput
Fetch Applicationget
Create Applicationpost
List Applicationsget
Candidates
Update Candidateput
Fetch Candidateget
List Candidatesget
Candidate Surveys
Fetch Candidate Surveyget
List Candidate Surveysget
Comments
Fetch Commentget
Create Commentpost
List Commentsget
Custom Attributes
Delete Custom Attributedelete
Update Custom Attributeput
Fetch Custom Attributeget
Create Custom Attributepost
List Custom Attributesget
Custom Fields
Delete Custom Fielddelete
Update Custom Fieldput
Fetch Custom Fieldget
Create Custom Fieldpost
List Custom Fieldsget
Departments
Delete Departmentdelete
Update Departmentput
Fetch Departmentget
Create Departmentpost
List Departmentsget
Divisions
Delete Divisiondelete
Update Divisionput
Fetch Divisionget
Create Divisionpost
List Divisionsget
Equality Monitoring Categories
Fetch equality monitoring categoryget
List equality monitoring categoriesget
Hiring Workflows
Fetch Hiring Workflowget
List Hiring Workflowsget
Interviews
Fetch Interviewget
List Interviewsget
Jobs
Delete Jobdelete
Update Jobput
Fetch Jobget
Create Jobpost
List Jobsget
Job Seekers
Fetch Job Seekerget
List Job Seekersget
Locations
Delete Locationdelete
Update Locationput
Fetch Locationget
Create Locationpost
List Locationsget
Onboarding Applications
Fetch Onboarding Applicationget
List Onboarding Applicationsget
Positions
Fetch Positionget
List Positionsget
Requisitions
Delete Requisitiondelete
Update Requisitionput
Fetch Requisitionget
Create Requisitionpost
List Requisitionsget
Requisition Templates
Fetch Requisition Templateget
List Requisition Templatesget
Structure Custom Group Ones
Delete Structure Custom Group Onedelete
Update Structure Custom Group Oneput
Fetch Structure Custom Group Oneget
Create Structure Custom Group Onepost
List Structure Custom Group Onesget
Structure Links
Delete Structure Linkdelete
Update Structure Linkput
Fetch Structure Linksget
Create Structure Linkpost
List Structure Linksget
Structured Sections
Fetch Structured Sectionsget
List Structured Sectionsget
Structured Section Responses
Delete Structured Section Responsedelete
Update Structured Section Responseput
Create Structured Section Responsepost
Users
Delete Userdelete
Fetch usersget
Create Userpost
List usersget

200OK: Positions collection

400Bad Request

401Unauthorized

403Forbidden

429Too Many Requests

500Internal Server Error