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=17
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=18",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=16",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/14e8cc7b-a88a-44b4-8d5b-c800b7622aeb/?format=api",
            "uuid": "14e8cc7b-a88a-44b4-8d5b-c800b7622aeb",
            "name": "Maastricht KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/0f94c129-02f4-4e73-b9d7-8e21f65463d8/?format=api",
            "uuid": "0f94c129-02f4-4e73-b9d7-8e21f65463d8",
            "name": "Medemblik"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/806f5414-5d98-4004-abbf-c4856bd80fee/?format=api",
            "uuid": "806f5414-5d98-4004-abbf-c4856bd80fee",
            "name": "Meerssen"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/920375c2-5bb5-45b7-a899-16e36fa39c70/?format=api",
            "uuid": "920375c2-5bb5-45b7-a899-16e36fa39c70",
            "name": "Metropoolregio Amsterdam KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/dbc19c0a-458e-44b3-b7f5-1852d46d5c67/?format=api",
            "uuid": "dbc19c0a-458e-44b3-b7f5-1852d46d5c67",
            "name": "Middelburg"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/8bddad2a-4125-4d1a-93d3-efd3e5aa0fdb/?format=api",
            "uuid": "8bddad2a-4125-4d1a-93d3-efd3e5aa0fdb",
            "name": "Middelburg KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/e43a583f-98c3-4b92-a64c-ae6bab228438/?format=api",
            "uuid": "e43a583f-98c3-4b92-a64c-ae6bab228438",
            "name": "Ministerie van Binnenlandse Zaken en Koninkrijkrelaties"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/7ec9e487-4574-4b6e-8164-aaf4f19207ec/?format=api",
            "uuid": "7ec9e487-4574-4b6e-8164-aaf4f19207ec",
            "name": "Musandam-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/b2487d80-3c3e-4e1c-b078-5620a8cdbf19/?format=api",
            "uuid": "b2487d80-3c3e-4e1c-b078-5620a8cdbf19",
            "name": "Muscat-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/74983d5a-0fd8-4c22-bb09-e7656d570fb6/?format=api",
            "uuid": "74983d5a-0fd8-4c22-bb09-e7656d570fb6",
            "name": "N&S Branch Office"
        }
    ]
}