Skip to main content

Basic formats

uuid​

Most id fields in the api are UUIDs

Example:

659ccf05-9871-4084-8755-ac329a194ff0

file_id​

file_id is a string that identifies a file downloadable at the endpoint /files/{file_id} (see Download). No other guarantees are made about the format of the file_id, and you should consider it to be an opaque string.

currency​

currency is the 3-letter ISO code for the currency. It is most often part of the Money object.
Example: EUR for the euro.

datetime​

datetime format is, following a modified version of RFC3339, formatted as full-date partial-time

Example:

date-time: 2022-06-28 11:13:54

year​

year is a year according to the gregorian calendar written in a string with the date-fullyear format.

month​

month is a month according to the gregorian calendar written in a string with the date-fullyear "-" date-month format.

Example:

2012-04: April 2012
1995-12: December 1995

date​

date is a is a date according to the gregorian calendar written in a string with the full-date format.