Rippling: Retrieve a specific time entry

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_time_entries

Provider route: GET /time-entries/{id}/. Alter supplies the connection’s credentials and routing.

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"]["getTimeEntries"]>[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.getTimeEntries(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_entries(arguments)
        result = await call.wait()
        return result.body_json()

Input

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

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
breaks	array	Optional	The breaks taken during the time entry.
breaks[]	Model	Each item	Expand Update a time entry — response body — breaks item
comments	array	Optional	The comments associated with the time entry.
comments[]	Model	Each item	Expand Update a time entry — response body — comments item
create_extra_hours_run	boolean	Optional	Whether the time entry should create an extra hours run.
created_at	string	Required within parent	Record creation date
end_time	string	Optional	The end time of the time entry.
id	string	Required within parent	Identifier field
idempotency_key	string	Optional	The unique key of the time entry in an outside system. If set, no other time entry with the same key can be created.
job_shifts	array	Optional	The job shifts worked during the time entry.
job_shifts[]	Model	Each item	Expand Update a time entry — response body — job shifts item
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.
piece_rate_premiums	array	Optional	The piece-rate premiums earned during the time entry.
piece_rate_premiums[]	Model	Each item	Expand Update a time entry — response body — piece rate premiums item
premiums	array	Optional	The premiums earned during the time entry.
premiums[]	Model	Each item	Expand Update a time entry — response body — premiums item
segments	array	Optional	The pay rates for each segment of the time entry.
segments[]	Model	Each item	Expand Update a time entry — response body — segments item
shift_input_values	array	Optional	Arbitrary shift inputs collected on the time entry
shift_input_values[]	Model	Each item	Expand Update a time entry — response body — shift input values item
start_time	string	Optional	The start time of the time entry.
status	string	Optional	The status of the time entry. Known values: DRAFT, APPROVED, PAID, FINALIZED
tags	array	Optional	The tags associated with the time entry.
tags[]	string	Each item
time_card	Model	Optional	Expand Update a time entry — response body — time card
time_card_id	string	Optional	The ID of the time card associated with the time entry.
time_entry_summary	Model	Optional	Expand Update a time entry — response body — time entry summary
updated_at	string	Required within parent	Record update date
worker	Model	Optional	Expand Update a time entry — response body — worker
worker_id	string	Required within parent	The ID of the worker associated with the time entry.

Referenced models: Update a time entry — response body — breaks item, Update a time entry — response body — job shifts item, Update a time entry — response body — piece rate premiums item, Update a time entry — response body — premiums item, Retrieve a report run — response body — meta redacted fields item, Update a time entry — response body — segments item, Update a time entry — response body — shift input values item, Update a time entry — response body — comments item, Update a time entry — response body — time card, Update a time entry — response body — time entry summary, Update a time entry — response body — worker

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_time_entries. Catalog operation: get-time-entries. 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-entries.read"]

Provider entitlements: ["API_Tier_1"]

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

Official provider source