Get started

The Cliquify API gives you programmatic access to your organization's creative resources.

It is a RESTful JSON API. Each resource has its own section in this documentation where you can learn exactly what operations you can perform.

Asset Tags are image labels used to categorize brand assets.

Template Tags are categories used to organize and discover templates.

Authentication

Authentication uses OAuth 2.0 client credentials. Every API call must include a Bearer token in the request header.

Find your Client ID and Client Secret in the developer portal under the OAuth client settings.

The required header in each request is:

Authorization: Bearer {ACCESS_TOKEN}

Each response will only include resources accessible to the company linked to your OAuth client.

OAuth scopes

Protected resource routes require all of the following scopes, which are requested automatically when you use the token endpoints See OAuth scopes

Making requests

All API requests are made to:

https://oauth.cliquify.me + resource endpoint

For example, to list templates, make a GET request to https://oauth.cliquify.me/api/templates.

Quick start

Step 1: Create an OAuth client

Create an OAuth client in the developer portal and copy the generated Client ID and Client Secret.

Step 2: Request an access token

Send your credentials to the token endpoint:

POST /oauth/access-token

Success response:

{
  "success": true,
  "token": {
    "token_type": "Bearer",
    "expires_in": 31536000,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."
  }
}

Step 3: Call a protected endpoint

Step 4: Manage your token

To verify whether a token is still active:

POST /oauth/introspect

To invalidate a token before it expires:

POST /oauth/revoke

Common errors

Code	Meaning
`401 Unauthorized`	Missing, invalid, or expired token
`403 Forbidden`	Token does not include required scopes; or enterprise account is inactive
`404 Not Found`	Company linked to this client could not be found
`422 Unprocessable Entity`	Invalid or missing request body (e.g. token required)
`429 Too Many Requests`	Rate limit exceeded

See Errors for details.

Authentication#

OAuth scopes#

Making requests#

Quick start#

Step 1: Create an OAuth client#

Step 2: Request an access token#

Step 3: Call a protected endpoint#

Step 4: Manage your token#

Common errors#