GET - /admin/users/count

General Information

Service	API	Method	Data Models	Workflow
urac	/admin/users/count	GET	Users

Description

This API counts users based on keywords. These keywords will be compared to usernames, emails, first names, and last names in the database.

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
keywords	Query	NO	String	N/A	Applied towards: email, username, firstName, or lastName
scope	Query	NO	String	enum [ "myTenancy", "otherTenancy" ]	This is available when main tenant roaming is enabled. Please note that this is available starting Stingray release

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

Valid Response Sample

{ 
  result: true,
  data: 2
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description
400	Business logic required data are missing
602	Model error: + %model_error%