Get a FavoriteList by id
GET/v1/favoritelists/:id
Get a FavoriteList by id
Request
Path Parameters
id stringrequired
FavoriteList identifier
Example: 60f1b9b3b3b3b3b3b3b3b3b3
Responses
- 200
- 400
- 403
- 404
- 500
Get a FavoriteList by id
- application/json
- Schema
- Example (from schema)
Schema
name stringrequired
Possible values: <= 64 characters
Favorite List name
companyId int
Favorite List company ID
contactId int
Favorite List contact ID
customerId int
Favorite List customer ID
productIds number[]
Favorite List product IDs list
clusterIds number[]
Favorite List cluster IDs list
isDefault booleanrequired
Default Favorite List
slug stringrequired
Favorite List slug
createdAt date-time
Favorite List date created
updatedAt date-time
Favorite List date modified
id stringrequired
Favorite List identifier
{
"name": "MyFavoriteList",
"companyId": 1111,
"contactId": 1111,
"customerId": 1111,
"productIds": [
1111,
2222,
3333
],
"clusterIds": [
1111,
2222,
3333
],
"isDefault": true,
"slug": "my-favorite-list-slug",
"createdAt": "2022-01-01T00:00:00.000Z",
"updatedAt": "2022-01-01T00:00:00.000Z",
"id": "64e896addf2137b255101f49"
}
Bad request
Forbidden
FavoriteList not found
Unknown get FavoriteList error
Loading...