Query Lists - Fabric

Query Lists

cURL

curl --request POST \
  --url https://prod01-apigw.yourcompany.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"
      ]
    }
  }
}
'

Python

import requests

url = "https://prod01-apigw.yourcompany.fabric.zone/api-list/list/query"

payload = {
    "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"] }
    }
}
headers = {
    "x-site-context": "<x-site-context>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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']}
    }
  })
};

fetch('https://prod01-apigw.yourcompany.fabric.zone/api-list/list/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod01-apigw.yourcompany.fabric.zone/api-list/list/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
            ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-site-context: <x-site-context>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://prod01-apigw.yourcompany.fabric.zone/api-list/list/query"

payload := strings.NewReader("{\n  \"limit\": 10,\n  \"offset\": 0,\n  \"sortBy\": \"updatedAt\",\n  \"sortDirection\": \"desc\",\n  \"filters\": {\n    \"userId\": [\n      \"33d01d57-4bfa-4a14-bacc-036617ec02b9\"\n    ],\n    \"name\": [\n      \"Summer List\"\n    ],\n    \"listType\": [\n      \"Wishlist\"\n    ],\n    \"notes\": [\n      \"Summer List\"\n    ],\n    \"attributes\": {\n      \"approver\": [\n        \"Jone Doe\"\n      ]\n    }\n  }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-site-context", "<x-site-context>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Example Response

{
  "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"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>"
}