The following standard verbs are used across the entire API:

  • create - creates a new entity
  • update - updates an already existing entity
  • upload - uploads data such a raw image
  • get - gets an existing an entity based on its id and other parameters if applicable
  • list - returns a list of objects based on the pagination input (if applicable) and other filter parameters

Note that the API endpoint naming schema is explicit in the sense that the verbs are present directly in the URL path (independent of the specific HTTP method used for each endpoint). For more details on this, see the full API specification below.