Users

Get user by ID

Changed on

Retrieves a single user by their numeric ID. Super-admins can access any user; regular users can only access users within their organization (or their own record).

get/users/{id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/users/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

User ID

Response

User found

messagestring

Example response

{
  "message": "OK",
  "data": {
    "id": 1,
    "name": "John",
    "surname": "Doe",
    "email": "john@example.com",
    "role_id": 1,
    "organization_id": 1
  }
}

Changes

  • 3b138b306b5bRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

  • d86d0bf8bebeRevision changes
    • info

      api operation id getUserById was added

    • info

      api tag Users added

    • info

      api tag Users - CRUD removed