Felt provides a public API you can use to programmatically interact with your Felt maps.
Endpoints in this API require you to authorize your request. To do this, you must include the following header:
authorization: Bearer <access token>
You can get an access token by following the steps in one of the Authentication and authorization methods listed below.
The responses from this API follow the JSON:API and OpenAPI conventions.
As such, success responses will always have the following fields:
| data | The contents of the response |
|---|---|
| links | If applicable, contains links to the resource that was created or updated |
The data object will have the following fields:
| id | The unique identifier for the resource |
|---|---|
| type | A short string specifying the type of resource being returned |
| attributes | The specific data for the resource |
For endpoints that return multiple values, the data field will be an array of objects with the properties outlined above.
Error responses on the other hand will always have the following fields:
| errors | An array of error objects |
|---|
Error objects have the following fields: