This document provides a high-level overview of the available API endpoints. These endpoints are designed to allow programmatic interaction with our data and services. Each endpoint is structured to facilitate specific operations, ensuring efficient data retrieval and manipulation.
Core Data Endpoints
GET/api/v1/users
Retrieves a list of all registered users. Supports pagination and filtering parameters.
GET/api/v1/users/{id}
Fetches details for a specific user identified by their unique ID.
POST/api/v1/users
Creates a new user account. Requires user data in the request body.
PUT/api/v1/users/{id}
Updates an existing user's information identified by their ID.
DELETE/api/v1/users/{id}
Removes a user account from the system.
Resource Management Endpoints
GET/api/v1/resources
Lists all available resources.
GET/api/v1/resources/{resourceId}/history
Retrieves the modification history for a specific resource.
POST/api/v1/resources/import
Imports resources from a specified data source.
Authentication and Authorization
POST/api/v1/auth/login
Authenticates a user and returns an access token.
POST/api/v1/auth/refresh
Refreshes an expired access token using a refresh token.
GET/api/v1/permissions/me
Retrieves the permissions associated with the currently authenticated user.
For detailed parameter descriptions, request/response examples, and error codes, please refer to the Full API Documentation.