Skip to main content
GET
Get a Supplier List

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.

zivio-tenant-id
string
header
required

Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.

Path Parameters

id
integer
required

Supplier List ID

Response

Supplier List details

id
integer
name
string
description
string
owner
string
is_public
boolean
Example:

true

list_type
enum<string>
Available options:
bespoke,
smart
Example:

"bespoke"

entry_criteria
string
visibility
string
default
boolean
Example:

true

sync_marketing
boolean
Example:

true

metadata
string
created_at
string
updated_at
string
suppliers
object[]