Overview
About the SharpLaunch API
Welcome to the Sharplaunch API v3! You can use our API to access Sharplaunch API endpoints, to retrieve and manage data about properties, leads, and more. You can also use the API to create custom applications that integrate with Sharplaunch.
- The SharpLaunch API supports only REST
- Apps must authenticate to interact with the SharpLaunch API
- The SharpLaunch API enforces rate limits on all requests
- All apps connecting to the SharpLaunch API are subject to SharpLaunch’s Terms of Service
Authentication
We implement OAuth2 in order to provide a secure API. This means all our end points are secured and can only be accessed with calls that are authenticated with tokens.
In order to obtain OAuth2 tokens, you must first authenticate with our Generate Token endpoint.
API Requests
Once you have obtained an access token, you can use it to authenticate API requests. To do this, include the access token in the Authorization
header of your request.
Example request:
curl --location 'https://test-api.sharplaunch.com/v3/properties' \
--header 'Authorization: Bearer <access_token>'
The access token is short-lived and will expire after 30 minutes.
You can use the refresh_token
to obtain a new access token when the current one expires.
Rate Limiting
- Requests are limited to 60 per minute.
- If you have exceeded your quota, a "429: Too Many Requests" response will be received.
Pagination
The API uses pagination to limit the number of results returned in a single response. The default limit is 10 results per page. You can specify the number of results you want to receive per page by using the limit
query parameter.