featureOS Customers API

Introduction

The featureOS Customers API allows you to create, update, and delete customers in featureOS. You can also retrieve customers and their associated data.

Authentication

To authenticate with the featureOS API, you must provide an API key. You can find your API key in your featureOS account settings.

API Versioning

The featureOS API is currently in version 3 (v3). We will only make backwards compatible changes to the API. We will announce any breaking changes in advance.

Rate Limiting

The featureOS API is rate limited to 100 requests per minute per API key. If you exceed this rate limit, you will receive a 429 Too Many Requests response.

Pagination

Requests that return multiple items will be paginated to 20 items by default. You can specify further pages with the page parameter. You can also set a custom page size up to 100 with the per_page parameter.

Errors

If you receive an error response, it will be a JSON object with a message key containing the error message.