User

Get user sub accounts.

Retrieves the collection of User resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

email
string
email[]
Array of strings
fiscal_id
string
fiscal_id[]
Array of strings
enabled
boolean
enabled[]
Array of booleans
Responses
200

User collection

get/users/me/accounts
Request samples 
Response samples 
[
  • {
    }
]
Create user sub account.
Creates a User resource.


SecurityBearer 
Request 
Request Body schema: 
required
The new User resource


email
required
password
required
string^((?=.*[A-z])(?=.*[0-9])(?=.*[!@#\$%\^&\*])(?...
 
fiscal_id
required
string
 
fullname
string or null
 
enabled
boolean or null
 Default:  true
 
Responses 
201
User resource created


400
Invalid input


422
Unprocessable entity


post/users/me/accounts
Request samples 
{
  • "email": "user@example.com",
  • "password": "string",
  • "fiscal_id": "string",
  • "fullname": "string",
  • "enabled": true
}
Response samples 
{
  • "email": "string",
  • "fiscal_id": "string",
  • "fullname": "string",
  • "enabled": true,
  • "created_at": "string",
  • "updated_at": "string"
}
Get user sub account by email.
Retrieves a User resource.


SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
200
User resource


404
Resource not found


get/users/me/accounts/{id}
Request samples 
Response samples 
{
  • "email": "string",
  • "fiscal_id": "string",
  • "fullname": "string",
  • "enabled": true,
  • "created_at": "string",
  • "updated_at": "string"
}
Update user sub account.
Replaces the User resource.


SecurityBearer 
Request 
path Parameters
id
required
string
 
Request Body schema: 
required
The updated User resource


fullname
string or null
 
enabled
boolean or null
 Default:  true
 
Responses 
200
User resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/users/me/accounts/{id}
Request samples 
{
  • "fullname": "string",
  • "enabled": true
}
Response samples 
{
  • "email": "string",
  • "fiscal_id": "string",
  • "fullname": "string",
  • "enabled": true,
  • "created_at": "string",
  • "updated_at": "string"
}
Delete user sub account.
Removes the User resource.


SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
204
User resource deleted


404
Resource not found


delete/users/me/accounts/{id}
Request samples 
Update sub account password by email.
Replaces the User resource.


SecurityBearer 
Request 
path Parameters
id
required
string
 
Request Body schema: 
required
The updated User resource


password
required
string^((?=.*[A-z])(?=.*[0-9])(?=.*[!@#\$%\^&\*])(?...
 
Responses 
200
User resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/users/me/accounts/{id}/change-password
Request samples 
{
  • "password": "string"
}
Response samples 
{
  • "email": "string",
  • "fullname": "string",
  • "invoicing_vat_number": "string",
  • "invoicing_fiscal_id": "string",
  • "invoicing_address": "string",
  • "invoicing_city": "string",
  • "invoicing_province": "string",
  • "invoicing_cap": "string",
  • "invoicing_name": "string",
  • "invoicing_country": "string",
  • "invoicing_sdi_recipient_code": "string",
  • "invoicing_sdi_pec": "string"
}
Get user profile.
Retrieves a User resource.


SecurityBearer 
Request 
path Parameters
id
required
any
 Value: "me"  
Responses 
200
User resource


404
Resource not found


get/users/{id}
Request samples 
Response samples 
{
  • "email": "string",
  • "fullname": "string",
  • "invoicing_vat_number": "string",
  • "invoicing_fiscal_id": "string",
  • "invoicing_address": "string",
  • "invoicing_city": "string",
  • "invoicing_province": "string",
  • "invoicing_cap": "string",
  • "invoicing_name": "string",
  • "invoicing_country": "string",
  • "invoicing_sdi_recipient_code": "string",
  • "invoicing_sdi_pec": "string"
}
Update user profile.
Replaces the User resource.


SecurityBearer 
Request 
path Parameters
id
required
any
 Value: "me"  
Request Body schema: 
required
The updated User resource


fullname
string or null
 
invoicing_vat_number
string or null
 
invoicing_fiscal_id
string or null
 
invoicing_address
string or null
 
invoicing_city
string or null
 
invoicing_province
string or null
 
invoicing_cap
string or null
 
invoicing_name
string or null
 
invoicing_country
string or null
 
invoicing_sdi_recipient_code
string or null
 
invoicing_sdi_pec
string or null
 
Responses 
200
User resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/users/{id}
Request samples 
{
  • "fullname": "string",
  • "invoicing_vat_number": "string",
  • "invoicing_fiscal_id": "string",
  • "invoicing_address": "string",
  • "invoicing_city": "string",
  • "invoicing_province": "string",
  • "invoicing_cap": "string",
  • "invoicing_name": "string",
  • "invoicing_country": "string",
  • "invoicing_sdi_recipient_code": "string",
  • "invoicing_sdi_pec": "string"
}
Response samples 
{
  • "email": "string",
  • "fullname": "string",
  • "invoicing_vat_number": "string",
  • "invoicing_fiscal_id": "string",
  • "invoicing_address": "string",
  • "invoicing_city": "string",
  • "invoicing_province": "string",
  • "invoicing_cap": "string",
  • "invoicing_name": "string",
  • "invoicing_country": "string",
  • "invoicing_sdi_recipient_code": "string",
  • "invoicing_sdi_pec": "string"
}
Update user password.
Replaces the User resource.


SecurityBearer 
Request 
path Parameters
id
required
string
 Value: "me"  
Request Body schema: 
required
The updated User resource


password
required
string^((?=.*[A-z])(?=.*[0-9])(?=.*[!@#\$%\^&\*])(?...
 
Responses 
200
User resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/users/{id}/change-password
Request samples 
{
  • "password": "string"
}
Response samples 
{
  • "email": "string",
  • "fullname": "string",
  • "invoicing_vat_number": "string",
  • "invoicing_fiscal_id": "string",
  • "invoicing_address": "string",
  • "invoicing_city": "string",
  • "invoicing_province": "string",
  • "invoicing_cap": "string",
  • "invoicing_name": "string",
  • "invoicing_country": "string",
  • "invoicing_sdi_recipient_code": "string",
  • "invoicing_sdi_pec": "string"
}