Person management
Journal management
API documentation
Account management
Persons
Journal
Gifts
Table of contents
This endpoint lets you manage gifts for a person.
Gifts can be used to track gift ideas, gifts you've given, or gifts you've received from a person. You can track the occasion, status, and other details about the gift.
Get the list of gifts
This endpoint gets the list of gifts for a specific person.
Gifts are ordered by creation date, with the most recent first.
URL parameters
The ID of the person.
Query parameters
No query parameters are available for this endpoint.
Response attributes
The ID of the gift.
The object type. Always 'gift'.
The name of the gift.
The occasion for the gift.
The URL associated with the gift.
The status of the gift. Possible values: idea, given, offered.
The date the gift was given, in Unix timestamp format.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": [
{
"id":
1
,
"object":
"gift"
,
"name":
"Birthday present"
,
"occasion":
"Birthday"
,
"url":
"https://example.com/gift"
,
"status":
"idea"
,
"gifted_at":
1715145600
,
"created_at":
1715145600
,
"updated_at":
1715145600
}
]
}
Create a new gift
This endpoint creates a new gift for a specific person. It will return the gift in the response.
URL parameters
The ID of the person.
Query parameters
The name of the gift. Maximum 255 characters.
The occasion for the gift.
The URL associated with the gift. Maximum 255 characters.
The status of the gift. Possible values: idea, given, offered.
The date the gift was given. Format: YYYY-MM-DD.
Response attributes
The ID of the gift.
The object type. Always 'gift'.
The name of the gift.
The occasion for the gift.
The URL associated with the gift.
The status of the gift. Possible values: idea, given, offered.
The date the gift was given, in Unix timestamp format.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": {
"id":
1
,
"object":
"gift"
,
"name":
"Birthday present"
,
"occasion":
"Birthday"
,
"url":
"https://example.com/gift"
,
"status":
"idea"
,
"gifted_at":
1715145600
,
"created_at":
1715145600
,
"updated_at":
1715145600
}
}
Get a specific gift
This endpoint retrieves a specific gift for a person.
URL parameters
The ID of the person.
The ID of the gift.
Query parameters
No query parameters are available for this endpoint.
Response attributes
The ID of the gift.
The object type. Always 'gift'.
The name of the gift.
The occasion for the gift.
The URL associated with the gift.
The status of the gift. Possible values: idea, given, offered.
The date the gift was given, in Unix timestamp format.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": {
"id":
1
,
"object":
"gift"
,
"name":
"Birthday present"
,
"occasion":
"Birthday"
,
"url":
"https://example.com/gift"
,
"status":
"idea"
,
"gifted_at":
1715145600
,
"created_at":
1715145600
,
"updated_at":
1715145600
}
}
Update a gift
This endpoint updates a specific gift for a person. It will return the updated gift in the response.
URL parameters
The ID of the person.
The ID of the gift.
Query parameters
The name of the gift. Maximum 255 characters.
The occasion for the gift.
The URL associated with the gift. Maximum 255 characters.
The status of the gift. Possible values: idea, given, offered.
The date the gift was given. Format: YYYY-MM-DD.
Response attributes
The ID of the gift.
The object type. Always 'gift'.
The name of the gift.
The occasion for the gift.
The URL associated with the gift.
The status of the gift. Possible values: idea, given, offered.
The date the gift was given, in Unix timestamp format.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": {
"id":
1
,
"object":
"gift"
,
"name":
"Birthday present"
,
"occasion":
"Birthday"
,
"url":
"https://example.com/gift"
,
"status":
"idea"
,
"gifted_at":
1715145600
,
"created_at":
1715145600
,
"updated_at":
1715145600
}
}
Delete a gift
This endpoint deletes a specific gift for a person. It will return a 204 No Content response on success.
URL parameters
The ID of the person.
The ID of the gift.
Query parameters
No query parameters are available for this endpoint.
Response
This endpoint returns a 204 No Content response with no body on success.
// Returns 204 No Content
Please login to vote.
It's free and will help us improve the page.
Taylor will be proud of you.
Last updated on April 5, 2025.