GET
/time_periods/{time_period_gid}Get a time period
Retrieves the full record for a single time period. Use opt_fields when you need additional properties beyond the default response. The response identifies the time period and includes its date range and period information.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
opt_fieldsarray<string>optional
Additional time period properties to include in the response, supplied as a comma-separated list; values can include nested parent fields such as `parent.display_name`. Allowed values are the documented time period property names.
200Returns the requested time period record in the `data` property.
dataobjectoptional
400Returned when a query parameter is missing or malformed.
errorsarray<object>optional
401Returned when a valid authentication token was not provided.
errorsarray<object>optional
403Returned when the authenticated user does not have access to the time period.
errorsarray<object>optional
404Returned when the request does not identify a known action or the time period does not exist.
errorsarray<object>optional
500Returned when a server-side problem prevents the record from being retrieved.
errorsarray<object>optional
Error handling
A 400 is returned when a query parameter is missing or malformed. A 401 is returned without a valid authentication token, and a 403 is returned when the authenticated user cannot access the time period. A 404 indicates that the time period does not exist, while a 500 indicates a server-side failure; opt_fields values must use the documented property names.