GET /admin/users/search

Find users matching a search query.

Request

  • Base URL
    https://developers.whmcs.com/api/v2
  • Auth
    none declared

Query parameters

querystring required

Search query

pageinteger
Example:1

Page number

page_sizeinteger
Example:10

Number of items per page. The maximum allowed value is 500. The default value is 50.

Response

User list

Example response

{
  "data": [
    {
      "email": "me@example.com",
      "firstname": "Davis",
      "lastname": "Davis",
      "clients": [
        {
          "uuid": "11C2M72y-z54n-5721-nnF8-13492be5uHiu"
        }
      ],
      "id": 123
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.