Realm

GET

URI:

• /api/v2/realm?limit=***

• /api/v2/realm?limit=***&page=***

Input fields:

Field Name	Type	Required	Description
limit	integer	No	The number of realms per page.
page	string	No	The cursor of the paginated page to retrieve.
name	string	No	The name of the realm.
id	string	No	The realm ID.
deleted	boolean	No	Get the deleted realm record.

Successful response fields:

Field name	Type	Description
description	string	A brief description of the realm.
deleted_at	datetime	The deleted timestamp. If the realm is not deleted, the field is None.
name	string	The name of the realm.
is_default	boolean	If the realm is the default realm.
id	string	The realm ID.

Response codes:

Code	Response content	Description
200 OK		Realm(s) info is successfully returned.
404 Not Found	Realm ID was not found	Cannot find the realm with the Realm ID.

Example request body:

None

Example of successful response body:

[ 
   { 
      "description":"abc", 
      "deleted_at":"None", 
      "name":"abc", 
      "is_default":false, 
      "id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx" 
   } 
]