Users
Users Endpoints

>>>

GET /users?page=&per=
List of users

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Response

{
  'data': [
    {
      'id': '6a1bb11e-ccd1-4084-b1d5-258d0ccc04d5',
      'name': 'Carlos',
      'lastname': 'Patiño',
      'matriname': 'Camarillo',
      'email': 'nicky@maggio.com',
      'job_title': null,
      'phone_number': null,
      'authy_id': null,
      'full_name': 'Carlos Patiño Camarillo'
    },
    {
      'id': '9425549a-c0c5-4da7-96d8-d62e25dcbe41',
      'name': 'José Luis',
      'lastname': 'Duran',
      'matriname': 'Nava',
      'email': 'hung@macejkovic.name',
      'job_title': null,
      'phone_number': null,
      'authy_id': null,
      'full_name': 'José Luis Duran Nava'
    }
  ],
  'meta': {
    'count': 2
  }
}

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
>>>

GET /users/:id
Specific user

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Response

{
  'data': {
    'id': '6a1bb11e-ccd1-4084-b1d5-258d0ccc04d5',
    'name': 'Carlos',
    'lastname': 'Patiño',
    'matriname': 'Camarillo',
    'email': 'nicky@maggio.com',
    'job_title': null,
    'phone_number': null,
    'authy_id': null,
    'full_name': 'Carlos Patiño Camarillo'
  }
}

Params

Param name Description
id
required

Requested user ID

Validations:

  • Must be a String