Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB
Gift list

Get gift list

Retrieves information about a gift list by its ID.

Permissions

This endpoint does not require permissions.

get/api/addon/pvt/giftlist/get/{listId}

Path parameters

listIdinteger required
Example:1

Gift list unique numerical identifier.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

giftListIdinteger

Gift list ID.

namestring

Gift list name.

userIdstring

User ID.

fileIdinteger nullable

File ID.

giftListTypeIdinteger

Gift list Type ID.

giftListTypeNamestring

Gift list Type name.

giftCardIdinteger

Gift card ID.

messagestring

Gift list message.

urlFolderstring

Slug of the gift list that will be part of its URL.

dateCreatedstring

Date when the gift list was created.

profileSystemUserAddressNamestring

Name of the user's address.

profileSystemUserIdstring

User ID on Profile System.

eventDatestring

Date of the event associated with the Gift list.

eventLocationstring

Location of the event associated with the Gift list.

eventCitystring

City of the event associated with the Gift list.

eventStatestring

State of the event associated with the Gift list.

telemarketingIdinteger nullable

Telemarketing ID.

telemarketingObservationstring nullable

Telemarketing observation.

IsPublicboolean

Defines if the gift list is public.

isActiveboolean

Defines if the gift list is active.

shipsToOwnerboolean

Defines if items purchased from the gift list will be shipped to the owner of the gift list.

isAddressOkboolean

Validates the address of the gift list.

versioninteger

Version of the gift list.

giftCardRechargeSkuIdinteger nullable

ID of the SKU that recharges the gift card.

memberNamesstring

Name of the members of the gift list.

giftListSkuIdsstring[] nullable

Array with the IDs of SKUs that are part of the gift list.

addressstring nullable

Address of the gift list.

fileUrlstring nullable

File URL.