POST
/
api-list
/
list
/
query
curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/query \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "limit": 10,
  "offset": 0,
  "sortBy": "updatedAt",
  "sortDirection": "desc",
  "filters": {
    "userId": [
      "33d01d57-4bfa-4a14-bacc-036617ec02b9"
    ],
    "name": [
      "Summer List"
    ],
    "listType": [
      "Wishlist"
    ],
    "notes": [
      "Summer List"
    ],
    "attributes": {
      "approver": [
        "Jone Doe"
      ]
    }
  }
}'
{
  "query": {
    "limit": 10,
    "offset": 0,
    "count": 1
  },
  "lists": [
    {
      "_id": "5fee9d59f2f08a1b3cbdea08",
      "createdAt": "2020-12-31T02:09:53.914Z",
      "updatedAt": "2020-12-31T02:09:53.914Z",
      "userId": "33d01d57-4bfa-4a14-bacc-036617ec02b9",
      "name": "Summer List",
      "listType": "Wishlist",
      "notes": "Summer List",
      "count": 10,
      "attributes": {
        "approver": "Jone Doe"
      }
    }
  ]
}

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

​
x-api-key
string
Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

Body

application/json
​
limit
number
Example:

10

​
offset
number
Example:

0

​
sortBy
string
Example:

"updatedAt"

​
sortDirection
string
default:desc
​
filters
object

Passing empty object will return all user lists

Response

200
application/json
Query user lists
​
query
object
​
lists
object[]