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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.id | string | Required within parent | Format: id |
query | object | Optional | Additional keys: not allowed |
query.expand | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
__meta | object | Optional | |
__meta.redacted_fields | array | Optional | |
__meta.redacted_fields[] | Model | Each item | Expand Retrieve a report run — response body — meta redacted fields item |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
pay_period | object | Optional | The pay period associated with the time card. |
pay_period.end_date | string | Optional | The end date of the pay period. |
pay_period.pay_schedule_id | string | Optional | The ID of the pay schedule associated with the pay period. |
pay_period.start_date | string | Optional | The start date of the pay period. |
summary | Model | Optional | Expand Retrieve a specific time card — response body — summary |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific time card — response body — worker |
worker_id | string | Required within parent | The 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
Schemas
Section titled “Schemas”22 more schemas are linked from the tables above, on the schema pages.
Retrieve a report run — response body — meta redacted fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info about the redacted fields. |
name | string | Optional | The name for the redacted field |
reason | string | Optional | The reason for the redaction |
Retrieve a specific time card — response body — summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The summary of the time card. |
approved_hours | JSON | Optional | |
approved_hours (anyOf 1) | number | Alternative | The approved hours for the pay period. |
approved_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
double_overtime_hours | JSON | Optional | |
double_overtime_hours (anyOf 1) | number | Alternative | The total number of doubletime hours worked during the pay period. |
double_overtime_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
earnings | JSON | Optional | |
earnings (anyOf 1) | number | Alternative | The earnings for the pay period. |
earnings (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours_worked_by_job_code | array | Optional | The amount of hours worked for each job code for the pay period. |
hours_worked_by_job_code[] | Model | Each item | Expand Retrieve a specific time card — response body — summary hours worked by job code item |
overtime_hours | JSON | Optional | |
overtime_hours (anyOf 1) | number | Alternative | The total number of overtime hours worked during the pay period. |
overtime_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
paid_hours | JSON | Optional | |
paid_hours (anyOf 1) | number | Alternative | The paid hours for the pay period. |
paid_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
premiums | JSON | Optional | |
premiums (anyOf 1) | number | Alternative | The premiums for the pay period. |
premiums (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
regular_hours | JSON | Optional | |
regular_hours (anyOf 1) | number | Alternative | The total number of regular hours worked during the pay period. |
regular_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_holiday_hours | JSON | Optional | |
total_holiday_hours (anyOf 1) | number | Alternative | The total holiday hours for the pay period. |
total_holiday_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_hours | JSON | Optional | |
total_hours (anyOf 1) | number | Alternative | The total hours for the pay period. |
total_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_paid_time_off_hours | JSON | Optional | |
total_paid_time_off_hours (anyOf 1) | number | Alternative | The total paid time off hours for the pay period. |
total_paid_time_off_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_unpaid_time_off_hours | JSON | Optional | |
total_unpaid_time_off_hours (anyOf 1) | number | Alternative | The total unpaid time off hours for the pay period. |
total_unpaid_time_off_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unpaid_break_hours_by_entry | JSON | Optional | |
unpaid_break_hours_by_entry (anyOf 1) | number | Alternative | The map of time entry to unpaidBreakHours in seconds |
unpaid_break_hours_by_entry (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hours_worked | JSON | Optional | |
hours_worked (anyOf 1) | number | Alternative | The total hours worked for the job codes. |
hours_worked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
job_codes_id | array | Optional | List of job code ids that this summary is tracking hours for. |
job_codes_id[] | string | Each item |
Retrieve a specific worker — response body — business partners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group | object | Optional | Business partner group the business partner is a part of Expandable field |
business_partner_group.created_at | string | Required within parent | Record creation date |
business_partner_group.default_business_partner | Model | Optional | Expand 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_id | string | Optional | Id 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.domain | string | Optional | Type of business partner group Known values: HR, IT, FINANCE, RECRUITING, OTHER |
business_partner_group.id | string | Required within parent | Identifier field |
business_partner_group.name | string | Required within parent | Name used to identify business partner group |
business_partner_group.updated_at | string | Required within parent | Record update date |
business_partner_group_id | string | Required within parent | Identifier of business partner group the business parter is a part of |
client_group | Model | Optional | Expand Create a new business partner — response body — client group |
client_group_id | string | Optional | Identifier of group of workers associated with the business partner |
client_group_member_count | JSON | Optional | |
client_group_member_count (anyOf 1) | integer | Alternative | Number of workers associated with the business partner |
client_group_member_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific worker — response body — manager Worker who is the business partner Expandable field |
worker_id | string | Required within parent | Identifier 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the team. |
parent | Model | Optional | Expand Update a team — response body — parent The parent team Expandable field |
parent_id | string | Optional | The parent team |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a team — response body — parent
Retrieve a specific worker — response body — work schedule value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scheduled working hours for a day of the week. |
hours | JSON | Optional | |
hours (anyOf 1) | number | Alternative | The number of scheduled working hours for the day. |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a specific worker — response body — country fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Country level fields for the worker. |
ca | object | Optional | Country-wise regional fields for Canada |
ca.sin | string | Optional | Social Insurance Number (SIN) for Canada employees. |
nz | object | Optional | Country-wise regional fields for New Zealand |
nz.ird_number | string | Optional | Inland Revenue Department (IRD) number for New Zealand employees. |
us | object | Optional | Country-wise regional fields for USA |
us.ssn | string | Optional | Social Security Number (SSN) for US employees. |
Retrieve a specific user — response body — photos item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | The classification of the photo. Known values: PHOTO, THUMBNAIL |
value | string | Optional | The URL of the photo. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}