Skip to content

List/Search#

List Organisations.

Query#

GET /api/v0/query

Request#

This is a Query API call, where:

  • listOrganisation is the query name
  {
    "query": [
        {
            "_name": "listOrganisation"
        },
        {
            "_fields": [
                {
                    "updatedAt": "desc"
                }
            ],
            "_name": "sort"
        },
        {
            "_name": "page",
            "from": 0,
            "to": 15
        }
    ]
}

Response#

Status codes#

  • 200: if query is run successfully
  • 401: Authentication error

ResponseBody Example#

[
    {
        "_createdAt": 1630385478884,
        "_createdBy": "[email protected]",
        "_id": "~204804296",
        "_type": "Organisation",
        "_updatedAt": 1630415216098,
        "_updatedBy": "[email protected]",
        "description": "SOC level",
        "links": [
            "cert"
        ],
        "name": "soc-level1"
    },
    {
        "_createdAt": 1606467059596,
        "_createdBy": "[email protected]",
        "_id": "~4144",
        "_type": "Organisation",
        "description": "CERT",
        "links": [
            "soc-level1"
        ],
        "name": "cert"
    },
    {
        "_createdAt": 1606464802479,
        "_createdBy": "[email protected]",
        "_id": "~8408",
        "_type": "Organisation",
        "description": "organisation for administration",
        "links": [],
        "name": "admin"
    }
]
{
  "type": "AuthenticationError",
  "message": "Authentication failure"
}

Last update: September 6, 2021 07:39:12