List Tenants

General Information

Service	API	Method
multitenancy	/tenants	GET

Workflow: List Tenants Flow

Data Models: Tenant

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
N/A	N/A	N/A	N/A	N/A	This API does not need any parameters; it fetches all tenant records.

Output

Valid Response

Valid Response Sample

{
	"result": true,
	"data": []
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[436],
        "details":[
            {
                "code":436,
                "message":"Unable to find tenants."
            }
        ]
    }
}

Error Codes

Code	Description
436	Unable to find tenants.

Example (CURL)

Request

Calling List Groups API

 > CURL -X GET http://127.0.0.1:4004/tenants

Response

List Groups API response

{
   "result": true,
   "data": [
      {
         
      },
      {
         
      }
   ]
}