Skip to main content

Standard Entity Fields

The TrackMage API consists of many object types. There are several attributes that are consistent across all objects:

  • id: Every TrackMage Object that can be created and received through the API has an id field that is used to refer to the object in other API calls. An id is represented by UUID. These id values may be used in many API endpoints to refer to an existing object rather than specifying the full object definition.
  • workspace: Most API Objects also include Workspace value in format '/workspaces/UUID' that is used to refer to the Workspace to which the object belongs. These Workspace values are required in the most API endpoints.
  • created_at/updated_at: Most API objects also include values for created_at and updated_at. These two fields respectively specify the time the object in question was created and most recently updated. These datetime fields are formatted according to ISO 8601.