For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authorisation Code Flow

Authorisation Code Flow is a two step process :

  1. Get authorisation code by making a GET request as below to the authorize URL - once the request is successful, you will receive an Authorizarion Code to your callback URL

  2. Exchange Authorisation Code obtained in above step for an Access token using Token (Auth Code Flow)

Authorises API request using Oauth 2.0 Authorization Code Flow

URL : /api/v1/oauth2/authorize Method : GET

Parameters

client_id (required) Your application client id

response_type (required) Use the value as “code”

state (required) Any random string to prevent from CSRF

redirect_uri (optional) Endpoint to handle authorisation response

Sample Request

curl https://my.worksmart.app/api/v1/oauth2/authorize?client_id=ibl90vqe9ll5198ss53v1b1knpk4fhacv4y7uzpa.worksmart.net&response_type=code&state=aozcah

Last updated