Get shared wishlist (paginated)
View a wishlist using a share token. Requires api-key for server verification. Returns paginated items.
GET
/api/v1/{app_id}/shared/wishlists/{token}- API
- Auth
- OpenAPI
- auth-api
- Updated
- Apr 26, 2026
auth-api:GET:/api/v1/{app_id}/shared/wishlists/{token}
View a wishlist using a share token. Requires api-key for server verification. Returns paginated items.
API ownership
- API family: Auth API
- Best for: Customer identity, session, token, cart, and wishlist flows.
- Do not use from: Merchant admin data syncs or public catalog rendering.
- Guide route: /apis/auth/latest
The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.
Operation
- Method:
GET - Path:
/api/v1/\{app_id\}/shared/wishlists/\{token\} - Summary: Get shared wishlist (paginated)
- Description: View a wishlist using a share token. Requires api-key for server verification. Returns paginated items.
- OpenAPI contract: auth-api
- Operation ID: Not documented in the OpenAPI contract.
Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| app_id | path | Yes | string | UUID of the app |
| token | path | Yes | string | Share token |
| page | query | No | integer | Page number (default: 1, minimum: 1) |
| per_page | query | No | integer | Number of items per page (default: 20, minimum: 1, maximum: 100) |
Request body
Not documented in the OpenAPI contract.
Responses
| Status | Description | Content |
|---|---|---|
| 200 | OK | application/json (object) |
| 400 | Invalid request parameters | application/json (object) |
| 404 | Wishlist not found or token expired | application/json (object) |
| 500 | Internal server error | application/json (object) |
200 - object
Wishlist With Items
| Property | Type | Required | Details |
|---|---|---|---|
created_at | string | No | - |
id | string | No | - |
is_default | boolean | No | - |
items | object[] | No | - |
name | string | No | - |
page | integer | No | - |
page_size | integer | No | - |
total_items | integer | No | - |
total_pages | integer | No | - |
updated_at | string | No | - |
user_id | string | No | - |
Wishlist Item
| Property | Type | Required | Details |
|---|---|---|---|
created_at | string | No | - |
id | string | No | - |
product | object | No | - |
product_id | string | No | - |
Product
| Property | Type | Required | Details |
|---|---|---|---|
brand | object | No | - |
created_at | string | No | - |
custom | object | No | - |
description | string | No | - |
html_description | string | No | - |
html_short_description | string | No | - |
id | string | No | - |
images | object[] | No | - |
product_name | string | No | - |
product_number | string | No | - |
short_description | string | No | - |
slug | string | No | - |
status | string | No | - |
translations_description | object | No | - |
translations_html_description | object | No | - |
translations_html_short_description | object | No | - |
translations_product_name | object | No | - |
translations_short_description | object | No | - |
translations_slug | object | No | - |
updated_at | string | No | - |
variants | object[] | No | - |
{
"created_at": "string",
"id": "string",
"is_default": false,
"items": [
{
"created_at": "string",
"id": "string",
"product": {
"brand": {
"id": null,
"name": null,
"slug": null,
"variant": null
},
"created_at": "string",
"custom": {},
"description": "string",
"html_description": "string",
"html_short_description": "string",
"id": "string",
"images": [],
"product_name": "string",
"product_number": "string",
"short_description": "string",
"slug": "string",
"status": "string",
"translations_description": {},
"translations_html_description": {},
"translations_html_short_description": {},
"translations_product_name": {},
"translations_short_description": {},
"translations_slug": {},
"updated_at": "string",
"variants": []
},
"product_id": "string"
}
],
"name": "string",
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0,
"updated_at": "string",
"user_id": "string"
}400 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}404 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}500 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}Contract identity
Use these fields to confirm you are implementing the intended endpoint contract.
- API family: Auth API
- Method:
GET - Path:
/api/v1/\{app_id\}/shared/wishlists/\{token\} - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Wishlist
- OpenAPI summary: Get shared wishlist (paginated)