List all cleanups

How to fetch a collection of cleanups via API

To fetch a collection of cleanups, send a GET request to the /api/cleanups endpoint.

Request

GET https://yourdomain.commercelayer.io/api/cleanups

Example

The following request fetches a collection of cleanups:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/cleanups/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of cleanups can be sorted by the following fields:

Attributes

  • resource_type

  • status

  • started_at

  • completed_at

  • interrupted_at

  • records_count

  • errors_count

  • processed_count

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Filterable fields

The list of cleanups can be filtered by the following fields:

Attributes

  • resource_type

  • status

  • started_at

  • completed_at

  • interrupted_at

  • records_count

  • errors_count

  • processed_count

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • events

Last updated