API Basics
Endpoint
The ToolPass API can be found at:
https://toolpass.net/api/v1
You can confirm the API is working by visiting this endpoint with a GET (e.g. through a browser). All data returned is encoded as JSON, unless specified otherwise.
{"api_version":"1.0","status":"ok"}
Adding and Removing members
Endpoints
There are 2 API enpoints used for adding and removing members
| API endpoint | Description |
|---|---|
| https://toolpass.net/api/v1/add-user | Add a member |
| https://toolpass.net/api/v1/remove-user | Remove a member |
Paramaters
| Parameter | Type | Description |
|---|---|---|
| api_key | string | Your API key |
| string | Members email address | |
| first_name | string | Members first name |
| last_name | string | Members last name |
Responses
| Key | Type | Example values | Description |
|---|---|---|---|
| api_version | float | 1.0 | Version of the API |
| status | string | ok, error | Was the API call successful? |