Skip to content

Rippling: Retrieve a specific time card

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

← Rest API operations · Get started

Operation rippling.rest_api.get_time_cards

Provider route: GET /time-cards/{id}/. 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"]["getTimeCards"]>[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.getTimeCards(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.get_time_cards(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parentFormat: id
queryobjectOptionalAdditional keys: not allowed
query.expandstringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
__metaobjectOptional
__meta.redacted_fieldsarrayOptional
__meta.redacted_fields[]ModelEach itemExpand Retrieve a report run — response body — meta redacted fields item
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
pay_periodobjectOptionalThe pay period associated with the time card.
pay_period.end_datestringOptionalThe end date of the pay period.
pay_period.pay_schedule_idstringOptionalThe ID of the pay schedule associated with the pay period.
pay_period.start_datestringOptionalThe start date of the pay period.
summaryModelOptionalExpand Retrieve a specific time card — response body — summary
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific time card — response body — worker
worker_idstringRequired within parentThe ID of the worker associated with the time card.

Referenced models: Retrieve a report run — response body — meta redacted fields item, Retrieve a specific time card — response body — summary, Retrieve a specific time card — response body — worker

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

Retrieve a report run — response body — meta redacted fields item
FieldTypePresenceDescription and constraints
$objectRootInfo about the redacted fields.
namestringOptionalThe name for the redacted field
reasonstringOptionalThe reason for the redaction
Retrieve a specific time card — response body — summary
FieldTypePresenceDescription and constraints
$objectRootThe summary of the time card.
approved_hoursJSONOptional
approved_hours (anyOf 1)numberAlternativeThe approved hours for the pay period.
approved_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
double_overtime_hoursJSONOptional
double_overtime_hours (anyOf 1)numberAlternativeThe total number of doubletime hours worked during the pay period.
double_overtime_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
earningsJSONOptional
earnings (anyOf 1)numberAlternativeThe earnings for the pay period.
earnings (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hours_worked_by_job_codearrayOptionalThe amount of hours worked for each job code for the pay period.
hours_worked_by_job_code[]ModelEach itemExpand Retrieve a specific time card — response body — summary hours worked by job code item
overtime_hoursJSONOptional
overtime_hours (anyOf 1)numberAlternativeThe total number of overtime hours worked during the pay period.
overtime_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
paid_hoursJSONOptional
paid_hours (anyOf 1)numberAlternativeThe paid hours for the pay period.
paid_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
premiumsJSONOptional
premiums (anyOf 1)numberAlternativeThe premiums for the pay period.
premiums (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
regular_hoursJSONOptional
regular_hours (anyOf 1)numberAlternativeThe total number of regular hours worked during the pay period.
regular_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_holiday_hoursJSONOptional
total_holiday_hours (anyOf 1)numberAlternativeThe total holiday hours for the pay period.
total_holiday_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_hoursJSONOptional
total_hours (anyOf 1)numberAlternativeThe total hours for the pay period.
total_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_paid_time_off_hoursJSONOptional
total_paid_time_off_hours (anyOf 1)numberAlternativeThe total paid time off hours for the pay period.
total_paid_time_off_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_unpaid_time_off_hoursJSONOptional
total_unpaid_time_off_hours (anyOf 1)numberAlternativeThe total unpaid time off hours for the pay period.
total_unpaid_time_off_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unpaid_break_hours_by_entryJSONOptional
unpaid_break_hours_by_entry (anyOf 1)numberAlternativeThe map of time entry to unpaidBreakHours in seconds
unpaid_break_hours_by_entry (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a specific time card — response body — summary hours worked by job code item

Retrieve a specific time card — response body — summary hours worked by job code item
FieldTypePresenceDescription and constraints
$objectRoot
hours_workedJSONOptional
hours_worked (anyOf 1)numberAlternativeThe total hours worked for the job codes.
hours_worked (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
job_codes_idarrayOptionalList of job code ids that this summary is tracking hours for.
job_codes_id[]stringEach item
Retrieve a specific worker — response body — business partners item
FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupobjectOptionalBusiness partner group the business partner is a part of

Expandable field
business_partner_group.created_atstringRequired within parentRecord creation date
business_partner_group.default_business_partnerModelOptionalExpand Retrieve a specific worker — response body — manager
Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

Expandable field
business_partner_group.default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
business_partner_group.domainstringOptionalType of business partner group
Known values: HR, IT, FINANCE, RECRUITING, OTHER
business_partner_group.idstringRequired within parentIdentifier field
business_partner_group.namestringRequired within parentName used to identify business partner group
business_partner_group.updated_atstringRequired within parentRecord update date
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker — response body — manager
Worker who is the business partner

Expandable field
worker_idstringRequired within parentIdentifier of worker who is the business partner

Referenced models: Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group

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 worker — response body — work schedule value
FieldTypePresenceDescription and constraints
$objectRootThe scheduled working hours for a day of the week.
hoursJSONOptional
hours (anyOf 1)numberAlternativeThe number of scheduled working hours for the day.
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve a specific worker — response body — country fields
FieldTypePresenceDescription and constraints
$objectRootCountry level fields for the worker.
caobjectOptionalCountry-wise regional fields for Canada
ca.sinstringOptionalSocial Insurance Number (SIN) for Canada employees.
nzobjectOptionalCountry-wise regional fields for New Zealand
nz.ird_numberstringOptionalInland Revenue Department (IRD) number for New Zealand employees.
usobjectOptionalCountry-wise regional fields for USA
us.ssnstringOptionalSocial Security Number (SSN) for US employees.
Retrieve a specific user — response body — photos item
FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalThe classification of the photo.
Known values: PHOTO, THUMBNAIL
valuestringOptionalThe URL of the photo.

SDK function policy ID: rippling.rest_api.get_time_cards. Catalog operation: get-time-cards. 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: ["time-cards.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.