REST API Documentation
This API serves as a secure, centralized engine that allows front-end applications to interact seamlessly with your platform’s core data by managing products, accounts, organizations, teams, and digital assets.
Before integrating with the API, please note the following restricted actions:
- Authentication: Password changes and initial password settings cannot be performed via these endpoints.
- Localization: Country changes are not permitted through this API.
Products
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v2/products | List all available products. |
Account
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v2/account | List all available products. |
| PUT | /api/v2/account | Update account information - Excludes password/country changes. |
Organization
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v2/organization | Get organization profile and information. |
| PUT | /api/v2/organization | Update organization information. |
Team
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v2/team | Get a list of all team members. |
| POST | /api/v2/team | Create/invite a new team member. |
| PUT | /api/v2/team/{member_id} | Update an existing team member's information. |
| DELETE | /api/v2/team/{member_id} | Remove a member from the team. |
Assets
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v2/assets | View and list assets. |
| POST | /api/v2/assets | Create/upload a new asset. |
| PUT | /api/v2/assets/{asset_id} | Update an existing asset. |
| DELETE | /api/v2/assets/{asset_id} | Remove/delete an asset. |
The API returns standard HTTP status codes to indicate the success or failure of an API request:
- 200 OK – The request was successful.
- 201 Created – The resource was successfully created.
- 400 Bad Requests – The request was invalid.
- 401 Unauthorized – Authentication failed or credentials were not provided.
- 403 Forbidden – You do not have permission to access the resource.
- 404 Not Found – The requested resource could not be found.