GET

Organisation List

Endpoint for interacting with organisations.

Query parameters

name Text filter on the name field. Filter methods like startswith, endswith and contains are supported. For case-insensitive filtering, use istartswith, iendswith and icontains.

uuid UUIDs must be separated by commas and must be specified in their canonical textual representation (in their 8-4-4-4-12 form, that is). Filtering on this field is always case insensitive. UUID fractions are supported too.

Subendpoints

/api/v4/organisations/{uuid}/contract returns contract information of the organisation. Only accessible by members of the organisation.

/api/v4/organisations/{uuid}/usage/ returns the count and total size of time series, rasters and scenarios for a specific organisation. Only accessible by members of the organisation.

/api/v4/organisations/{uuid}/users/ returns all users in the specified organisation and their roles. Only accessible by members of the organisation. User roles may be patched by managers.

Examples

/api/v4/organisations/?name__icontains=schuur

/api/v4/organisations/?uuid=61f5a464-c350-44c1-9bc7-d4b42d7f58cb

/api/v4/organisations/?uuid=C350-44C1-9BC7,9C6C-40A9-A5FC

/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/contract/

/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/usage/

/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/users/

GET /api/v4/organisations/?format=api&page=4
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 305,
    "next": "https://demo.lizard.net/api/v4/organisations/?format=api&page=5",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=3",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/964a9ee0-d952-4674-8bc2-70a05fc0f458/?format=api",
            "uuid": "964a9ee0-d952-4674-8bc2-70a05fc0f458",
            "name": "Beemster"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/7a2284a6-a8ac-4e12-a9c6-4b6308f1f598/?format=api",
            "uuid": "7a2284a6-a8ac-4e12-a9c6-4b6308f1f598",
            "name": "Bergen NH"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/c933c1ba-26de-42a8-b64d-28c35e628a4b/?format=api",
            "uuid": "c933c1ba-26de-42a8-b64d-28c35e628a4b",
            "name": "Beverwijk"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/445229e1-0ed2-426c-a95d-8423af87b3e0/?format=api",
            "uuid": "445229e1-0ed2-426c-a95d-8423af87b3e0",
            "name": "Blik Sensing"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/883eecb4-1783-4526-9dc7-8ca9118ba3df/?format=api",
            "uuid": "883eecb4-1783-4526-9dc7-8ca9118ba3df",
            "name": "BlueLabel"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/5dafca3b-9390-4389-bb23-35803bf8714b/?format=api",
            "uuid": "5dafca3b-9390-4389-bb23-35803bf8714b",
            "name": "BoundaryCreek"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/aecd056b-df8e-4649-8f55-a1cd5d931b42/?format=api",
            "uuid": "aecd056b-df8e-4649-8f55-a1cd5d931b42",
            "name": "Brabant Water"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/117077eb-5d36-425a-9319-c79a23934a66/?format=api",
            "uuid": "117077eb-5d36-425a-9319-c79a23934a66",
            "name": "Bureau of Meteorology Australia"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/9c153a2e-b2e9-4638-bccb-cc6b2f35ea36/?format=api",
            "uuid": "9c153a2e-b2e9-4638-bccb-cc6b2f35ea36",
            "name": "CECI Engineering Consultancy Inc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/983cda50-9f8d-4aad-ae78-4e2b38a9639b/?format=api",
            "uuid": "983cda50-9f8d-4aad-ae78-4e2b38a9639b",
            "name": "CHT"
        }
    ]
}