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=11
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=12",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=10",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/6e48d904-499c-44ba-a775-d044f86b9608/?format=api",
            "uuid": "6e48d904-499c-44ba-a775-d044f86b9608",
            "name": "Heiloo"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/b1b44c11-8bdf-44bb-be62-6fe8b9458b92/?format=api",
            "uuid": "b1b44c11-8bdf-44bb-be62-6fe8b9458b92",
            "name": "Hittestress demo"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/01015652-fd0a-40a5-a893-532becadfb8a/?format=api",
            "uuid": "01015652-fd0a-40a5-a893-532becadfb8a",
            "name": "Hittestress demo 2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/a1b98fd7-20aa-40af-b583-cf6f1e0cc139/?format=api",
            "uuid": "a1b98fd7-20aa-40af-b583-cf6f1e0cc139",
            "name": "Hittestress demo 3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/2bf14037-3e6a-413b-8407-0d40347080b0/?format=api",
            "uuid": "2bf14037-3e6a-413b-8407-0d40347080b0",
            "name": "Hogeschool Rotterdam"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/60e554ef-e412-4e95-96b2-5b5634b0ab7f/?format=api",
            "uuid": "60e554ef-e412-4e95-96b2-5b5634b0ab7f",
            "name": "Hollands Kroon"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
            "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
            "name": "Hoogheemraadschap Hollands Noorderkwartier"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/35a01338-7a11-447b-92ae-d736df0a9c2c/?format=api",
            "uuid": "35a01338-7a11-447b-92ae-d736df0a9c2c",
            "name": "Hoogheemraadschap Hollands Noorderkwartier KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/2cdbf687-dc6f-4898-9ce3-316c828a2121/?format=api",
            "uuid": "2cdbf687-dc6f-4898-9ce3-316c828a2121",
            "name": "Hoogheemraadschap van Delfland"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/d7bd9cf0-28ce-4901-866f-5d2e63402804/?format=api",
            "uuid": "d7bd9cf0-28ce-4901-866f-5d2e63402804",
            "name": "Hoogheemraadschap van Rijnland"
        }
    ]
}