Working With APIs

HTTP Actions and API Endpoints

Learn about the relationship between endpoint names and HTTP actions.

An endpoint's name indicates the type of data it handles and the action it performs on that data. The most common actions are:

Action HTTP Method Description
Create POST Creates and persists an entity of the corresponding type.
List GET Returns all instances of a particular entity that match query parameters you provide.
Retrieve GET Returns the single instance of an entity that matches the identifier you provide.
Update PUT Modifies the existing entity that matches the identifier you provide.
Delete DELETE Deletes the existing entity that matches the identifier you provide. Deleted entities cannot be retrieved or undeleted.