Skip to main content
GET
/
list
/
{listId}
Get list detail by Id
curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/list/{listId} \
  --header 'Authorization: Bearer <token>'
{
  "name": "Wishlist",
  "userId": null,
  "listId": "5349b4ddd2781d08c09890f4",
  "listType": "Wish list",
  "notes": "Add items to your wishlist to purchase later",
  "attributes": {
    "attr1": "value1",
    "attr2": "value2"
  },
  "count": 0,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
listId
string
required

ID of the list whose details are to be retrieved.

Response

List object found

List details

​
name
string
required
Example:

"Wishlist"

​
userId
string
required
Example:

null

​
listId
string
Example:

"5349b4ddd2781d08c09890f4"

​
listType
string
Example:

"Wish list"

​
notes
string
Example:

"Add items to your wishlist to purchase later"

​
attributes
object
Example:
{ "attr1": "value1", "attr2": "value2" }
​
count
integer<int32>

Number of items added to the list.

Required range: x >= 0
Example:

0

​
createdAt
string<date-time>
​
updatedAt
string<date-time>