Skip to main content

​
Introduction

Lead’s API are REST based, accepts and returns JSON-encoded payloads, and uses standard HTTP response codes, authentication, and verbs.

​
Authentication

Lead uses OAuth2 for Authentication. When we onboard your program, you will be setup with a client_id and a client_secret. These credentials can be used to retrieve an access_token which you will use to authenticate further requests.
By default, access tokens have a 24 hour expiry, and will need to be replaced before they expire. See the expires_in passed in the token response to track the . They can also be limited to certain API scopes which can help you with access control while preventing unauthorized requests.

​
Steps

1

Get Access Token

Use your client_id and client_secret to get an access_token with the Authentication API.
2

Authenticate Requests

Use the access_token in the 'authorization: Bearer <access_token>' header to authenticate further API requests.