Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Bin

List Bin Entries

Retrieves a list of resources moved to the bin. The following resources can be moved to the bin:

  • campaigns
  • vouchers
  • products
  • SKUs

To use this endpoint, you must have the following permissions:

  • vouchers.read
  • campaigns.read
  • products.read
get/v1/trash-bin

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

order'id' | '-id'

Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order.

starting_after_idstring

A cursor for pagination. It retrieves the results starting after a result with the given ID.

junction'and' | 'or'

Logical Operator Between Filters. Filter by conditions set on the junction parameter indicating how the conditions should be accounted for in the query. An AND is an all-inclusive logical operator, meaning the AND operator displays a record if ALL the conditions separated by AND are TRUE, while an OR operator displays a record if ANY of the conditions separated by OR is TRUE.

Filters for listing bin entries.

Response

Returns the list of all the bin entries matching the query parameters.

object'list' required

The type of the object represented by JSON. This object stores information about the bin entries in a dictionary.

data_ref'data' required

Identifies the name of the attribute that contains the array of bin entry objects.

totalinteger required

The total number of bin entries. This is the number of the entries returned in the array, not the number of all matching results or all resources currently moved to the bin.

has_moreboolean required

As query results are always limited (by the limit parameter), the has_more flag indicates if there are more records for given filter parameters. This lets you know if you can run another request with a starting_after_id query or a different limit to get more records returned in the results.

more_starting_afterstring

If has_more is true, it returns an ID that can be used to return another page of results. Use the ID in the starting_after_id query parameter to display another page of the results occuring after the field with that ID.

Example response

{
  "data": [
    {
      "id": "tbe_0e8213a0a78020ec64",
      "created_at": "2024-03-27T19:24:26.142Z",
      "deleted_by_user_id": "user_lNTg47u7Ip0Smgcm1k3ShHuUdH4qToNc",
      "resource_id": "v_ZUFwkglCEWaEfXqkJYd3uogTEEHEEU8S",
      "resource_type": "voucher",
      "resource_name": "BLCKFRIDAY_2024",
      "resource_parent_id": "camp_snn0eQL0PYWl5b6lY6HQNPfb",
      "object": "voucher"
    }
  ]
}