Skip to content
v1.0.0

User service

User service API


Get all users

GET
/users

Retrieve a list of users

Responses

A list of users
application/json
JSON
[
{
"id": "string",
"name": "string",
"email": "string"
}
]

Playground

Samples

cURL
JavaScript
PHP
Python

Add a user

POST
/users

Create a new user

Request Body

application/json
JSON
{
"id": "string",
"name": "string",
"email": "string"
}

Responses

User created successfully

Playground

Body

Samples

cURL
JavaScript
PHP
Python

Get a single user

GET
/users/{id}

Get user data by its ID

Parameters

Path Parameters

id*
Typestring
Required

Responses

Object with user data
application/json
JSON
{
"id": "string",
"name": "string",
"email": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

Modify a user

PUT
/users/{id}

Update an existing user

Parameters

Path Parameters

id*
Typestring
Required

Request Body

application/json
JSON
{
"id": "string",
"name": "string",
"email": "string"
}

Responses

User updated successfully

Playground

Variables
Key
Value
Body

Samples

cURL
JavaScript
PHP
Python

Remove a user

DELETE
/users/{id}

Delete a user by ID

Parameters

Path Parameters

id*
Typestring
Required

Responses

User deleted successfully

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

Get a single user

GET
/users/email/{email}

Get user data by its email

Parameters

Path Parameters

email*
Typestring
Required
formatemail

Responses

Object with user data
application/json
JSON
{
"id": "string",
"name": "string",
"email": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

Powered by VitePress OpenAPI

Marco Frattarola