API ReferenceListings

List listings

GET /rest/v1/listings

GET
/listings

The query surface for everything channel-side. ?status=error returns every failing listing; add error_contains to target one specific failure. This is the exact filter your retry runs should use: after fixing a cause, retry only the listings failing with THAT error (POST /listings/batch with action: retry), never every listing in error. Listings of removed products (deleted, or removed by an import undo) are not listed and answer 404 by id. Required scope: products:read.

AuthorizationBearer <token>

Authorization: Bearer nbl_live_... (or nbl_test_... for test mode). Test-mode writes are validated and simulated but never persisted and never touch channels; simulated results are marked simulated.

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
Default25
cursor?string
product_id?string
channel_account_id?string
channel?string

Base channel filter (e.g. ebay matches every eBay account).

status?string

New values may be added; tolerate unknowns.

Value in

  • "listed"
  • "imported"
  • "ongoing"
  • "error"
  • "delisted"
error_code?"channel_error"

Only listings whose issues[] contain this code. Today every channel failure has code channel_error (same as status=error); use error_contains to target one specific error.

Value in

  • "channel_error"
error_contains?string

Only listings in error whose CURRENT error message contains this text (case-insensitive, 3–200 characters, matched literally). Older errors of the same listing are ignored.

Length3 <= length <= 200
updated_after?string

Listings whose updated_at is after this time (status, error or content change). Poll with the time of your previous poll; an invalid timestamp is a 422.

Formatdate-time

Response Body

application/json

application/json

curl -X GET "https://example.com/listings?error_contains=item+specific+Brand"
{  "object": "list",  "has_more": true,  "next_cursor": "string",  "data": [    {      "id": "list_9ac2e",      "object": "listing",      "product_id": "string",      "channel_account_id": "string",      "channel": "string",      "status": "listed",      "id_on_channel": "string",      "url_on_channel": "http://example.com",      "site": "string",      "overrides": {        "title": "string",        "description": "string",        "category_id": "string"      },      "content": {        "title": "string",        "description": "string"      },      "attributes": {},      "variants": [        {          "variant_id": "var_66a1f1",          "sku": "string",          "id_on_channel": "string"        }      ],      "issues": [        {          "code": "photo_required_for_channel",          "severity": "error",          "message": "string",          "attribute_names": [            "string"          ]        }      ],      "operation_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

Last updated on October 18, 2026

Need help?

Email us and a human replies, usually within one business day.