Query Lists

Query Lists

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

x-api-key

string

Body

application/json

filters

object

Passing empty object will return all user lists

Show child attributes

filters.attributes

object

filters.listType

any[]

filters.name

any[]

filters.notes

any[]

filters.userId

any[]

limit

number

offset

number

sortBy

string

sortDirection

string

default:

desc

Response

200 - application/json

lists

object[]

Show child attributes

lists._id

string

lists.attributes

object

lists.count

integer

lists.createdAt

string

lists.listType

string

lists.name

string

Minimum length: 3

lists.notes

string

lists.updatedAt

string

lists.userId

string

query

object

Show child attributes

query.count

number

query.limit

number

query.offset

number