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=2
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=3",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/0a1ec1c2-9712-44c2-83e1-eebd0cda4f94/?format=api",
            "uuid": "0a1ec1c2-9712-44c2-83e1-eebd0cda4f94",
            "name": "AlDhahira-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/d2cd7285-92f8-4371-a04d-3738581cf151/?format=api",
            "uuid": "d2cd7285-92f8-4371-a04d-3738581cf151",
            "name": "AlWusta-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/aee734d3-3988-4e32-a52a-af7d2280101b/?format=api",
            "uuid": "aee734d3-3988-4e32-a52a-af7d2280101b",
            "name": "Alivar-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/0fbe7bce-c367-49a3-9d36-e36cc059f32e/?format=api",
            "uuid": "0fbe7bce-c367-49a3-9d36-e36cc059f32e",
            "name": "Alkmaar"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/bca7ea06-e0e9-403f-8bae-edef33f30876/?format=api",
            "uuid": "bca7ea06-e0e9-403f-8bae-edef33f30876",
            "name": "Almelo"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/83280e0e-2100-4a72-8f5f-78cc6abaedfb/?format=api",
            "uuid": "83280e0e-2100-4a72-8f5f-78cc6abaedfb",
            "name": "Almere"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/c36db291-62c5-403e-a6e1-f386748bd7c3/?format=api",
            "uuid": "c36db291-62c5-403e-a6e1-f386748bd7c3",
            "name": "Almere KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/dad2bb25-85fe-450c-88e6-2f5698c7e729/?format=api",
            "uuid": "dad2bb25-85fe-450c-88e6-2f5698c7e729",
            "name": "Almere_test"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/85178fef-ddd1-4822-86e1-4527c4cd0be8/?format=api",
            "uuid": "85178fef-ddd1-4822-86e1-4527c4cd0be8",
            "name": "Alphen aan den Rijn"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/ad7db3a0-353d-4cbe-878f-a00590eb297f/?format=api",
            "uuid": "ad7db3a0-353d-4cbe-878f-a00590eb297f",
            "name": "Alphen aan den Rijn KA"
        }
    ]
}