Admin APIEmail Deliverability
List suppressed addresses
Newest first.
Authorization
bearer_auth AuthorizationBearer <token>
Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.
In: header
Path Parameters
store_id*string
Store id
Format
uuidQuery Parameters
limit?integer
Page size, 1 to 200. Defaults to 50.
Format
int64Range
1 <= value <= 200cursor?string
next_cursor from the previous page. Omit for the first page.
offset?integer
Rows to skip, for UIs that jump to a page number. Ignored when
cursor is set. Prefer cursor for walking a whole list.
Format
int64Range
0 <= valueinclude_total?boolean
Also return total, the count of all matching rows. Costs an extra
query; leave off when you only walk pages.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/email/suppressions?limit=50"{
"data": [
{
"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "string",
"source": "string"
}
],
"has_more": true,
"next_cursor": "string",
"total": 0
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}