Our API documentation lists parameters and return values for each function, and we always describe the data type for
each field. This will tell you how to store and format the data on your end. Most of our data types are pretty standard,
but you should pay special attention to the
Uid type because it's our proprietary system for storing primary keys in
our database, and if you're not careful, Uids in your code might be cast to floats which will break things.
Here are all of the different data types we use:
Uid - This stands for "Unique Identifier". It's a very long number (normally 31 digits) that is totally unique in our database.
Even though Uids only contain numeric characters, we recommend storing them as strings because
if you store a Uid as a number (e.g. an Int) it's likely to get rounded to a float because of how long it is, and that
Text - A string of text.
Number - An integer.
Bool - A boolean (or true/false) value.
UserId - Each LACRM user has a UserId. If you work on a team with other people, you can use their UserId for things
like assigning tasks to them. This is a number, but unlike a Uid, it will fit within an int, so you don't need to treat it as a string.
Date - A string representing a date using the format
DateTime - A string representing both a date and time. When we return date/time fields from the API, we use the
ISO 8601 format (e.g.
2019-07-25T16:00:00-05:00). When you're passing date/times
to the API, we'll do our best to handle other formats, but we recommend using ISO 8601 to be sure we won't misinterpret anything.
Enum - Short for enumeration. These fields are fields with a preset selection of options. The documentation will explain what the valid options are.
Array of [Type] - Sometimes you can pass more than one value to a single field. For example, if you want to filter a report
to only show data assigned to a specific user, you might be able to pass in multiple UserIds to show data for all of those users.
Array of objects - This is a special version of Array of [Type] because each item in the array will be another object/array
with its own fields. This is common when returning lists of things. For example, if you want to get a list of tasks, the response
will contain a list of objects, and each object will be an array with the information about a task.