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=3
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=4",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=2",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/60d5ae82-29ad-4378-b7f2-b0122eeb241a/?format=api",
            "uuid": "60d5ae82-29ad-4378-b7f2-b0122eeb241a",
            "name": "Amstel, Gooi & Vechtstreek"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/6519e8a4-8990-4d1a-a0c4-e5c3ea58bb7b/?format=api",
            "uuid": "6519e8a4-8990-4d1a-a0c4-e5c3ea58bb7b",
            "name": "Amsterdam"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/fde1dacf-dc5f-445d-8b78-5408dbd4c9d8/?format=api",
            "uuid": "fde1dacf-dc5f-445d-8b78-5408dbd4c9d8",
            "name": "Apeldoorn"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/4ba80ae0-193a-4f43-be77-9a0a48db003f/?format=api",
            "uuid": "4ba80ae0-193a-4f43-be77-9a0a48db003f",
            "name": "Arnhem"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/f762bb55-e788-43aa-a08d-8116132c91f6/?format=api",
            "uuid": "f762bb55-e788-43aa-a08d-8116132c91f6",
            "name": "Artesia"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/cfed22b2-8c80-4bcf-b575-70f6fab831c2/?format=api",
            "uuid": "cfed22b2-8c80-4bcf-b575-70f6fab831c2",
            "name": "AshSharqiyahNorth-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/b4cc1d7e-abf6-4b91-ba17-9c0a5ab67a7f/?format=api",
            "uuid": "b4cc1d7e-abf6-4b91-ba17-9c0a5ab67a7f",
            "name": "AshSharqiyahSouth-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/2a204924-d838-47aa-be67-7fce2a7e9761/?format=api",
            "uuid": "2a204924-d838-47aa-be67-7fce2a7e9761",
            "name": "BAR KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/91cf9190-e0c9-452a-a291-6526bda6ad3b/?format=api",
            "uuid": "91cf9190-e0c9-452a-a291-6526bda6ad3b",
            "name": "BODIS"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/48dac75b-ef8a-42eb-bb52-e8f89bbdb9f2/?format=api",
            "uuid": "48dac75b-ef8a-42eb-bb52-e8f89bbdb9f2",
            "name": "BWN HHNK"
        }
    ]
}