list Query

Description

Retrieves a single customer list by its reference ID. Customer lists are used to organize and group buyers for marketing and communication purposes.

query list($listRef: ID!) {
  list(listRef: $listRef) {
    _id
    id
    title
    description
    created
    count
    system
  }
}

Variables

{
    "listRef": "cbd43ee05040b06bbf6b1ec3"
}

Response

{
    "list": {
        "_id": "f0ba9f3e551875071ba8c2c1",
        "id": 4856278477937,
        "title": "example",
        "description": "example",
        "created": 1718507093901,
        "count": 10,
        "system": true
    }
}

Arguments

Name	Type	Description
listRef	ID!	Reference ID of the customer list to retrieve.

Returns

List