For date and time parameters, this API uses the ISO 8601 format. This format provides a standardized and widely compatible way of representing date and time.
The ISO 8601 date-time format is structured as follows:
YYYY-MM-DDTHH:MM:SSZ
Where:
YYYY
- Four-digit year (e.g., 2023)MM
- Two-digit month (01 to 12)DD
- Two-digit day (01 to 31)T
- Separator between date and timeHH
- Two-digit hour in 24-hour format (00 to 23)MM
- Two-digit minute (00 to 59)SS
- Two-digit second (00 to 59)Z
- UTC timezone designator, or an optional timezone offset (e.g., +05:00 or -08:00)
Examples:
Parameter | Description |
---|---|
createdFrom=2023-01-01T00:00:00Z | Records created from the very beginning of January 1, 2023, in UTC. |
createdTo=2023-12-31T23:59:59Z | Records created up to the last second of December 31, 2023, in UTC. |
createdFrom=2023-01-01T00:00:00+05:00 | January 1, 2023, midnight in UTC+5 time zone. |