Skip to content

Rippling: GET Timecards for an Employee

Rippling tandAapi.getTimecardsForRole: arguments, response, policy and SDK examples.

← Tand aapi operations · Get started

Operation rippling.t_and_a_api.get_timecards_for_role

Provider route: GET /platform/api/timecards/for_role. 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["tandAapi"]["getTimecardsForRole"]>[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.tandAapi.getTimecardsForRole(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.tand_aapi.get_timecards_for_role(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.rolestringRequired within parent
query.limitintegerOptional
query.offsetintegerOptional

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

FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand GET Timecard — response body

Referenced models: GET Timecard — response body

GET Timecard — response body
FieldTypePresenceDescription and constraints
$objectRootA timecard object is an instance that tracks a role's time logged in T&A across an entire pay period. The object specifically references a TimecardSummary instance, which takes down all of the hours logged for the role in the pay period in T&A and breaks them down.
idstringOptionalUnique identifier for timecard
payPeriodModelOptionalExpand GET Pay Periods for an Employee — response body — item
rolestringOptionalRippling identifier for target user
timecardSummaryModelOptionalExpand GET Timecard — response body — timecard Summary

Referenced models: GET Pay Periods for an Employee — response body — item, GET Timecard — response body — timecard Summary

GET Pay Periods for an Employee — response body — item
FieldTypePresenceDescription and constraints
$objectRootA pay period object.
endDatestringOptional
paySchedulestring or nullOptional
startDatestringOptional
GET Timecard — response body — timecard Summary
FieldTypePresenceDescription and constraints
$objectRootA timecard summary object is a breakdown of all hours that match a specific timecard. The object breaks down all earned hours by earning id, all premium hours by earning id, all hours by job codes, amongst others.
stringOptional
approved_hoursstringOptionalTotal approved hours in the timecard.
earningsobjectOptionalA breakdown of total worked hours by earning type id in the timecard.
earnings.[earning_id]stringOptional
job_codesarrayOptionalA breakdown of total worked hours by job codes in the timecard.
job_codes[]objectEach item
job_codes[].codesarrayOptional
job_codes[].codes[]stringEach item
job_codes[].hoursstringOptional
overtime_hoursstringOptionalTotal overtime hours in the timecard.
paid_hoursstringOptionalTotal paid hours in the timecard.
premiumsobjectOptionalA breakdown of total premium hours by earning type id in the timecard.
premiums.[earning_id]stringOptional
regular_hoursstringOptionalTotal regular hours (base pay) in the timecard.
total_holiday_hoursstringOptionalTotal paid holiday hours in the timecard.
total_hoursstringOptionalTotal worked hours in the timecard.
total_paid_time_off_hoursstringOptionalTotal paid time off hours in the timecard.
total_unpaid_time_off_hoursstringOptionalTotal unpaid time off hours in the timecard.

SDK function policy ID: rippling.t_and_a_api.get_timecards_for_role. Catalog operation: t-and-a-api.get-timecards-for_role. 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.

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.