APIv4 Actions

With a few exceptions, most API Entities support a basic set of CRUD (create, read, update, delete) actions, along with some metadata actions to retrieve information about the structure of the entity.

API Explorer

The easiest way to see which actions are available for each entity is to browse the API Explorer, which shows all available entities, their actions, and the parameters for each action.

Most entities support the following actions:

Metadata Actions

• checkAccess

  Check if current user is authorized to perform a specified action on a given record.

• getActions

  Returns a list of actions avaiable for a given entity.

• getFields

  Fetch the list of fields supported by the entity, including custom fields. Optionally load the option-lists for fields.

Read Actions

• get

  Search for records based on query parameters. For most entities, get includes advanced features such as joins.

Write Actions

• create

  Insert a single new record into the database.

• update

  Update one or more existing records with new values.

• save

  Save an array of records. For each one, the presence of an id determines whether an existing record will be updated.

• delete

  Delete one or more records based on query parameters. Some entities, including Contact, implement "Soft Delete", in which case the delete action's default behavior is to give records an intermediate "trashed" status. For these entities, set useTrash = FALSE to delete records permanently.

• replace

  Replace an existing set of records with a new or modified set of records. For example, replace a group of "Phone" numbers for a given contact.

Warning

Replace includes an implicit delete action - use with care & test well before using in production.