| layout | group | title | guide_version |
|---|---|---|---|
default |
rest-api |
REST API reference |
2.3 |
Magento exposes different REST endpoints depending on the type of user making the requests. You must request and include a security token to gain access to the Customer and Admin REST API endpoints.
See Token-based authentication for instructions on requesting and using security tokens.
{: .bs-callout .bs-callout-warning} The list of Admin REST API endpoints contains a large number of endpoints and takes longer to load.
Each of the following links lead to a list of REST endpoints specific to a user type:
-
Admin REST API endpoints - Available using an admin security token.
-
Customer REST API endpoints - Available using a customer security token
-
Guest REST API endpoints - Available for anonymous users
You can run POST and PUT endpoints asynchronously while the async.operations.all message queue consumer is active. Asynchronous web endpoints provides information about asynchronous routes, payloads, and responses.
-
Admin REST API endpoints - Available using an admin security token.
-
Customer REST API endpoints - Available using a customer security token
-
Guest REST API endpoints - Available for anonymous users