Giftnote API Documentation

You can access API credentials within the Giftnote app under Settings > Integrations > Giftnote API.

API Credentials Example

• Client ID: 6963c0-2
• API Quota Limit: 10 requests/hour
• API Token: No token generated yet. Click the button below to generate a new token.

Keep your Client ID and API Token secure. Do not share them with others or expose them in any client-side code.

Authentication

To use the Giftnote API, request an access token. Tokens expire after one hour.

Requesting Access Token

Send a POST request to:

https://api.giftnote.com/auth/oauth/token

Request headers:

Content-Type: application/x-www-form-urlencoded Authorization: Basic [base64 encoding of client_id:api_token]

Request body:

grant_type=client_credentials

cURL Example:

curl --location --request POST 'https://api.giftnote.com/auth/oauth/token/' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Basic [encoded_client_id:api_token]' \ --data-urlencode 'grant_type=client_credentials'

Example successful response:

{ \"access_token\": \"example-token-response\", \"expires_in\": 3600, \"token_type\": \"Bearer\" }

API Usage

After obtaining your OAuth token, you can make requests to your desired endpoint.

Each request consumes one quota. Quotas refresh hourly.

Base URL for API endpoints:

https://api.giftnote.com/[collection]/v0/

Request headers for API calls:

Authorization: Bearer [access_token from OAuth request]