Get list by listId

curl --request GET \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId} \
  --header 'x-site-context: <x-site-context>'

import requests

url = "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}"

headers = {"x-site-context": "<x-site-context>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-site-context': '<x-site-context>'}};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}', 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.{customer_name}.fabric.zone/api-list/list/{listId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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;
}

package main

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

func main() {

	url := "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-site-context", "<x-site-context>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-site-context"] = '<x-site-context>'

response = http.request(request)
puts response.read_body

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

{
  "code": "LIST_TYPE_NOT_FOUND",
  "message": "List type ID not found"
}

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

GET

api-list

list

{listId}

Get list by listId

curl --request GET \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId} \
  --header 'x-site-context: <x-site-context>'

import requests

url = "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}"

headers = {"x-site-context": "<x-site-context>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-site-context': '<x-site-context>'}};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}', 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.{customer_name}.fabric.zone/api-list/list/{listId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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;
}

package main

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

func main() {

	url := "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-site-context", "<x-site-context>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-site-context"] = '<x-site-context>'

response = http.request(request)
puts response.read_body

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

{
  "code": "LIST_TYPE_NOT_FOUND",
  "message": "List type ID not found"
}

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

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"

Path Parameters

listId

string

required

Response

List for specific listId

_id

string

Example:

"5fee9d59f2f08a1b3cbdea08"

createdAt

string

Example:

"2020-12-31T02:09:53.914Z"

updatedAt

string

Example:

"2020-12-31T02:09:53.914Z"

userId

string

Example:

"33d01d57-4bfa-4a14-bacc-036617ec02b9"

name

string

Minimum string length: 3

Example:

"Summer List"

listType

string

Example:

"Wishlist"

notes

string

Example:

"Summer List"

count

integer

Example:

10

attributes

object

Example:

{ "approver": "Jone Doe" }

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Get list by listId

Headers

Path Parameters

Response