Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

ServiceAPIMethod
urac/admin/users/countGET


Data Model: Users

Workflow: List Count Users Flow

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
tIdBody or QueryNOStringN/AIf set, the api will return the users of a specific tenant; else the api returns all the users in the database


Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": {
		"count": 12
	}
}

...

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[600400],
        "details":[
            {
                "code": 600400,
                "message": "Database connection error"
            }
        ]
    }
}



Error Codes



Code
Description
600
400
Database connection error


Example (CURL)

...

Request

Code Block
languagebash
titleCalling List Users API
 > CURL -X GET http://127.0.0.1:4000/urac/admin/users/count?tId=5551aca9e179c39b760f7a1a

Response

Code Block
languagejs
titleList Users API response
{
	"result": true,
	"data": {
		"count": 12
	}
}

...