Getting your list of connections using the Okappy API
To get your list of connections using the Okappy API, follow the instructions below.
Authentication
First you will need to get an up to date authentication token.
For further information see authenticating with Okappy.
Getting your list of connections
Get your list of connections using the following endpoint.
GET /connections/CONNECTION_TYPE
Where CONNECTION_TYPE is either customer or subcontractor.
Headers
| Header | Content |
|---|---|
| Authorize | Bearer token |
The token should be a string taken from the “access_token” field of a response to an authorise request.
Parameters
No parameters.
Responses
| Code | Description |
|---|---|
| 200 | Operation successful |
| 204 | No data returned |
| 400 | Bad request |
| 401 | Unauthorised |
| 415 | Data sent in wrong format (should be JSON) |
| 429 | Too many requests in a short period of time (please try again later) |