This is an example API documentation. It is not intended to be used in production.
This is an example version section. The current version of the API is 2.0.0.
The previous version of the API is 1.0.0. Documentation for the previous version can be found at:
This is an example authentication section
This is an example API key authentication section with code snippet. The API key must be provided in the Authorization header of the request as follows:
Authorization: ApiKey <your_api_key>
This is an example endpoints section
The name of the user
The user was successfully created
{
"message": "User created successfully",
"data": {
"id": "123",
"name": "John Doe"
}
}
The user was not created
{
"message": "User not created"
}
The user ID
The user was successfully retrieved
{
"message": "User retrieved successfully",
"data": {
"id": "123",
"name": "John Doe"
}
}
The user was not found
{
"message": "User not found"
}
The user ID
The name of the user
The user was successfully updated
{
"message": "User updated successfully",
"data": {
"id": "123",
"name": "John Doe"
}
}
The user was not updated
{
"message": "User not updated"
}
The user ID
The user was successfully deleted
{
"message": "User deleted successfully",
"data": {
"id": "123",
"name": "John Doe"
}
}
The user was not deleted
{
"message": "User not deleted"
}
The users were successfully retrieved
{
"message": "Users retrieved successfully",
"data": [{
"id": "123",
"name": "John Doe"
}, {
"id": "456",
"name": "Jane Doe"
}]
}
The users were not found
{
"message": "Users not found"
}