Skip to main content

GET /gift_requests/:id

Retrieve gift request information.

Description

This endpoint allows you to retrieve a specific gift request by its unique identifier.

HTTP Request

GET https://api.andopen.com/gift_requests/:id

Responses

The state field indicates the current status of the gift request and can have one of the following values:

ValueDescription
submittedGift request has been submitted and is awaiting redemption
redeemedGift request has been redeemed by the recipient
dispatchedGift has been dispatched for delivery
deliveredGift has been successfully delivered
cancelledGift request has been cancelled
🟢 Success Response (200 Success)
{
"data": {
"type": "gift_requests",
"id": "4fb4cb3f-9666-43b5-8884-7f5194483d1a",
"attributes": {
"redemption_url": "https://from.andopen.co/r/yJVd73kgurRzEX",
"state": "submitted",
"created_at": "2025-01-27T10:30:00Z",
"updated_at": "2025-01-27T10:30:00Z"
}
}
}
🔴 Error Response (404 NotFound)
{
"errors":
[
{
"status": "404",
"detail": "Couldn't find GiftRequest with e276c11e-f27b-4a6d-b9e4-f53cd5cd3d32"
}
],
"jsonapi": {
"version": "1.0"
}
}

Code Examples

curl -X GET "https://api.andopen.com/gift_requests/e276c11e-f27b-4a6d-b9e4-f53cd5cd3d32" \
-H 'Content-Type: application/vnd.api+json' \
-H 'AndOpen-API-Version: 2025-09' \
-H "Authorization: Bearer <api_key>