GET /admin/api/{api_version}/events.json

Retrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

Servers

Path parameters

Name Type Required Description
api_version String Yes

Request headers

Name Type Required Description
x-shopify-access-token String No

Query parameters

Name Type Required Description
limit String No

The number of results to show.(default: 50)(maximum: 250)

verb String No

Show events of a certain type.

filter String No

Show events specified in this filter.

since_id String No

Show only results after the specified ID.

created_at_max String No

Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)

fields String No

Show only certain fields, specified by a comma-separated list of field names.

created_at_min String No

Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.