Periods
Access actions associated with specific periods.
Overview
Periods are used to represent specific timeframes within your team. All dates are in UTC and follow the ISO 8601 format (e.g., 2024-01-01T01:01:00.000Z
)
Get Periods
Get all periods, optionally within a specified date range.
GET /periods
GET /periods
Query Parameters
Success Response
A successful response will have an HTTP status of 200.
Response Properties
Example Response
The sample response below shows periods retrieved successfully within a specified date range.
Get Actions for a Period
Get actions occurring during a period within your team. You can optionally specify form fields to include additional custom data in the action responses. All dates must be in ISO 8601 format (e.g., 2024-08-12T11:58:19.349Z
) and are returned in UTC.
GET /periods/{period_id}/actions
GET /periods/{period_id}/actions
Query Parameters
The form_fields
parameter allows you to request specific custom fields associated with the actions in the period. These fields should be provided as an array of strings and must be URL-encoded when included in the request. Only the fields specified will be returned in the response. If a requested field is not found for a action, a note will be included in the response under the notes
property indicating which fields were missing.
Success Response
HTTP Status Code: 200
Response Properties
Example Response
The sample response below indicates that actions have been retrieved successfully. All dates are in ISO 8601 format and UTC.
Error Responses
If there was an issue with the request, you might receive one of the following error responses:
Invalid period_id
HTTP Status Code: 400
Period Not Found
HTTP Status Code: 404
Invalid form_fields
HTTP Status Code: 400
Last updated