SEsellauth
Whitelist

Get Whitelist

Changed on

Retrieves the whitelist entries.

get/v1/shops/{shopId}/whitelist

Request

Request body

pageinteger nullable

Page number.

perPageinteger nullable

Items per page, 1-100. Must be at least 1. Must not be greater than 100.

orderColumn'id' | 'value' | 'type' | 'reason' | 'enabled' | 'created_at' nullable
orderDirection'asc' | 'desc' nullable
idstring nullable

Filter by entry ID.

typesstring[]
valuestring nullable

Filter by whitelisted value.

reasonstring nullable

Filter by reason.

payment_method_idsobject nullable

Filter by payment method IDs.

enabledboolean nullable

Only enabled or disabled entries.

active_fromstring nullable

Must be a valid date.

active_tostring nullable

Must be a valid date. Must be a date after <code>active_from</code>.

created_at_fromstring nullable

Must be a valid date.

created_at_tostring nullable

Must be a valid date. Must be a date after <code>created_at_from</code>.

Example request

{
  "page": 1
}

Response

current_pageinteger
first_page_urlstring
frominteger
last_pageinteger
last_page_urlstring
next_page_urlstring nullable
pathstring
per_pageinteger
prev_page_urlstring nullable
tointeger
totalinteger

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "shop_id": 1,
      "type": "email",
      "value": "trusted@sellauth.test",
      "payment_method_ids": null,
      "reason": "Example entry",
      "enabled": true,
      "active_from": null,
      "active_to": null,
      "created_at": "2026-11-01T20:00:51.000000Z",
      "updated_at": "2026-11-01T20:00:51.000000Z",
      "deleted_at": null
    }
  ],
  "first_page_url": "http://api.sellauth.test/v1/shops/1/whitelist?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://api.sellauth.test/v1/shops/1/whitelist?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "page": null,
      "active": false
    },
    {
      "url": "http://api.sellauth.test/v1/shops/1/whitelist?page=1",
      "label": "1",
      "page": 1,
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "page": null,
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://api.sellauth.test/v1/shops/1/whitelist",
  "per_page": 20,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

Changes

  • ff0d59c98d7aRevision changes
    • breaking

      request property / was restricted to a list of enum values

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added the new asn enum value to the request property /

    • info

      added the new city enum value to the request property /

    • info

      added the new country_code enum value to the request property /

    • info

      added the new discord_id enum value to the request property /

    • info

      added the new email enum value to the request property /

    • info

      added the new email_domain enum value to the request property /

    • info

      added the new ip enum value to the request property /

    • info

      added the new ip_range enum value to the request property /

    • info

      added the new isp enum value to the request property /

    • info

      added the new user_agent enum value to the request property /

    • info

      added the optional property // to the response with the status