Introduction
Proposable's API is designed around REST with a simple resource-specific URL structure. All responses are JSON-encoded.
Check out the full API Reference here.
Base URL
The API can be accessed via: https://api.proposable.com
Authentication
Requests can be authenticated using your personal API access token, or through a custom OAuth 2 client access token.
Access tokens can be sent as a Query Parameter, for example
https://api.proposable.com/v1/activities?access_token=your-access-token
Or as an Authorization header Bearer token, for example
Authorization: Bearer your-access-token
OAuth 2 Clients and Third-Party Applications
Create an OAuth 2 Client for your application to access accounts outside of your organization.
The system will ask for the Name of your application and the Redirect URI.
OAuth 2 Authorization and Token Generation
After generating an Oauth 2 Client, you will receive a Client ID
and a Secret Key
To gain access to an account outside of your organization using your OAuth 2 Client
1. Send the user to the authorization endpoint, for example:
Required Arguments
client_id
response_type
The value should be
code
redirect_uri
2. Trade the provided code for a valid Access Token
After the user authenticates and authorizes your application, the system will redirect the user back to your application via the redirect_uri
and return the code
query parameter.
To retrieve the user's access token, make a POST request to the /oauth/token
endpoint with the following parameters:
client_id
client_secret
code (provided on redirect)
grant_type
The value should be
authorization_code
redirect_uri
Here is a quick example of this request using CURL
curl -X POST https://api.proposable.com/oauth/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d client_id=your-client-id \
-d client_secret=your-client-secret \
-d code=the-code-provided-on-redirect \
-d grant_type=authorization_code \
-d redirect_uri=https://example.com/your-redirect-uri
Next Steps
Now that you have access token(s) you can begin making requests to the API. The Proposable API allows you to manage proposals, templates, contacts, and more.
Check out the API Reference for all endpoints and additional information.