Skip to content

Rippling: List headcount positions

Rippling restApi.listHeadcountPositions: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.list_headcount_positions

Provider route: GET /headcount-positions/. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["listHeadcountPositions"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.listHeadcountPositions(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.list_headcount_positions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.filterstringOptional
query.expandstringOptional
query.order_bystringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
__metaModelOptionalExpand List Sites — response body — meta
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List headcount positions — response body — results item

Referenced models: List headcount positions — response body — results item, List Sites — response body — meta

38 more schemas are linked from the tables above, on the schema pages.

List headcount positions — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
actual_compensationModelOptionalExpand Retrieve a specific headcount position — response body — actual compensation
backfill_forModelOptionalExpand Retrieve a specific headcount position — response body — backfill for
backfill_for_idstringOptionalID of the worker for whom this headcount position was requested as a backfill
comp_band_compensationModelOptionalExpand Retrieve a specific headcount position — response body — comp band compensation
created_atstringRequired within parentRecord creation date
current_start_datestringOptionalMost recent start date estimate or the actual hire date if already filled
departmentModelOptionalExpand Retrieve a specific headcount position — response body — department
department_idstringOptionalID for the department the headcount belongs to
employment_typeModelOptionalExpand Retrieve a specific headcount position — response body — employment type
employment_type_idstringOptionalID for the employment type the headcount is assigned to
end_datestringOptionalTargeted end date for the headcount
headcount_ownerModelOptionalExpand Retrieve a specific headcount position — response body — headcount owner
headcount_owner_idstringOptionalID for the headcount owner
idstringRequired within parentIdentifier field
in_budgetbooleanOptionalWhether the headcount position is in budget
job_functionobjectOptionalJob function assigned to this headcount

Expandable field
job_function.created_atstringRequired within parentRecord creation date
job_function.idstringRequired within parentIdentifier field
job_function.namestringOptionalDisplayed name of the job function
job_function.updated_atstringRequired within parentRecord update date
job_function_idstringOptionalID for the job function the headcount is assigned to
job_requisitionModelOptionalExpand Retrieve a specific headcount position — response body — job requisition
job_requisition_idstringOptionalID for the job requisition the headcount is associated with
levelModelOptionalExpand Retrieve a specific headcount position — response body — level
level_idstringOptionalID for the level the headcount is assigned to
location_factorModelOptionalExpand Retrieve a specific headcount position — response body — location factor
location_factor_idstringOptionalID for the location factor the headcount is assigned to
notesstringOptionalHeadcount notes
position_idstringOptionalPosition name for the headcount, for ex PID100037
position_sub_typestringOptionalMore granular classification of headcount position type. `NEW` New headcount created, typically paired with the OPEN_HEADCOUNT type. `BACKFILL` Replacement headcount for someone who left the company. `FORECASTED_ATTRITION` Headcount that does not count toward the budget, also known as provisional position in the application, `HIRING_STAGE` Person is going through the hiring process, paired with the FUTURE_START type. `OFFER_STAGE` Offer has been extended to a candidate, awaiting their decision. Paired with the FUTURE_START type. `OFFER_ACCEPTED` Candidate has accepted the offer but has not yet started. Paired with the FUTURE_START type. `PLAN_CHANGE` Headcount status changed due to business decision. Paired with CLOSED type. `TERMINATED` Role was filled, but the employee was separated from the company. Paired with CLOSED type. `TRANSFERRED` Employee moved internally to another role. Paired with CLOSED type.
Known values: NEW, BACKFILL, FORECASTED_ATTRITION, HIRING_STAGE, OFFER_STAGE, OFFER_ACCEPTED, PLAN_CHANGE, TERMINATED, TRANSFERRED
position_typestringOptionalType of headcount position. `OPEN_HEADCOUNT` A headcount position that's not yet filled. `FUTURE_START` Headcount where a candidate is going through the hiring process, or an offer has been accepted, but the person has not yet started. `ACTIVE` Headcount where a candidate has been hired and started. `CLOSED` Headcount that's no longer available to fill.
Known values: OPEN_HEADCOUNT, FUTURE_START, ACTIVE, CLOSED
priorityobjectOptionalPriority assigned to this headcount

Expandable field
priority.created_atstringRequired within parentRecord creation date
priority.idstringRequired within parentIdentifier field
priority.namestringOptionalDisplay name of the headcount priority
priority.updated_atstringRequired within parentRecord update date
priority_idstringOptionalID for the headcount priority
recruiterModelOptionalExpand Retrieve a specific headcount position — response body — recruiter
recruiter_idstringOptionalID for the recruiter working on filling the position
target_start_datestringOptionalThe estimated start date when the position was first created
teamsarrayOptionalTeams the headcount belongs to

Expandable field
teams[]ModelEach itemExpand Update a team — response body — parent
teams_idarrayOptionalIDs for the teams the headcount belongs to
teams_id[]stringEach item
titlestringOptionalJob title for the position. For a vacant headcount position, this can be defined on creation. Once the position is occupied, it’s synched from the associated worker’s job title.
updated_atstringRequired within parentRecord update date
work_locationModelOptionalExpand Retrieve a specific headcount position — response body — work location
work_location_idstringOptionalID for the work location the headcount is assigned to
workerModelOptionalExpand Retrieve a specific headcount position — response body — worker
worker_idstringOptionalID for the worker hired into the headcount

Referenced models: Update a team — response body — parent, Retrieve a specific headcount position — response body — actual compensation, Retrieve a specific headcount position — response body — backfill for, Retrieve a specific headcount position — response body — comp band compensation, Retrieve a specific headcount position — response body — department, Retrieve a specific headcount position — response body — employment type, Retrieve a specific headcount position — response body — headcount owner, Retrieve a specific headcount position — response body — job requisition, Retrieve a specific headcount position — response body — level, Retrieve a specific headcount position — response body — location factor, Retrieve a specific headcount position — response body — recruiter, Retrieve a specific headcount position — response body — work location, Retrieve a specific headcount position — response body — worker

List Sites — response body — meta
FieldTypePresenceDescription and constraints
$objectRootA list of redacted fields.
redacted_fieldsarrayOptional
redacted_fields[]objectEach item
redacted_fields[].namestringOptionalThe name for the redacted field
redacted_fields[].reasonstringOptionalThe reason for the redaction
Update a team — response body — parent
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the team.
parentModelOptionalExpand Update a team — response body — parent
The parent team

Expandable field
parent_idstringOptionalThe parent team
updated_atstringRequired within parentRecord update date

Referenced models: Update a team — response body — parent

Retrieve a specific headcount position — response body — job requisition
FieldTypePresenceDescription and constraints
$objectRootJob requisition the headcount is associated with

Expandable field
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentJob requisition name
statusstringRequired within parentJob requisition status
Known values: OPEN, CLOSED, PUBLISHED, DRAFT, ARCHIVED
updated_atstringRequired within parentRecord update date

SDK function policy ID: rippling.rest_api.list_headcount_positions. Catalog operation: list-headcount-positions. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["headcount-positions.read"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.