All Collections
Working with our API
Getting started with our API
Getting started with our API
Robbert Scholten avatar
Written by Robbert Scholten
Updated over a week ago

Our API is organised around REST and lets you interact directly with Target Circle from anything that can send an HTTP request. Every API endpoint returns JSON encoded as UTF-8 and uses HTTP response codes to indicate errors.

The API host is api.targetcircle.com.

Authentication

Authentication is done via HTTP headers. X-Api-Token authenticates the endpoint with the API token for your account.

curl -X GET \
     -H "X-Api-Token : API_TOKEN" \
     "https://api.targetcircle.com/api/v1/offers"

For JavaScript usage, the API supports Cross-Origin Resource Sharing (CORS), so that you can use these headers in conjunction with XMLHttpRequest.

Parameters

Parameters are passed in the URL's query string. They must be properly URL-encoded using the UTF-8 encoding for non-ASCII characters. The plus character (+) is interpreted as a space and can be used as an alternative to %20. Arrays can be passed as a comma-separated string, for example: country=us,uk,no 

Did this answer your question?