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
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=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/93bcc95f-40d3-4b77-919d-da9374ee866c/?format=api",
            "uuid": "93bcc95f-40d3-4b77-919d-da9374ee866c",
            "name": "3Di Global"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/bf5b7a0b-c350-4489-a4f0-191e6d9e87f7/?format=api",
            "uuid": "bf5b7a0b-c350-4489-a4f0-191e6d9e87f7",
            "name": "3Di test"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/bb00e372-5de1-433f-afaa-de7a0423b68f/?format=api",
            "uuid": "bb00e372-5de1-433f-afaa-de7a0423b68f",
            "name": "API Cursus"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/46a767b0-487b-419c-b679-fa735a079b4b/?format=api",
            "uuid": "46a767b0-487b-419c-b679-fa735a079b4b",
            "name": "AS50 KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/5d0509a3-699e-41b7-8074-22d66494e093/?format=api",
            "uuid": "5d0509a3-699e-41b7-8074-22d66494e093",
            "name": "AS50+"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/086a4dfe-6fbe-4369-8e4a-320c5007c053/?format=api",
            "uuid": "086a4dfe-6fbe-4369-8e4a-320c5007c053",
            "name": "Academic License"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/bb7a4853-d481-4d54-8e8d-5fadbbe0eca5/?format=api",
            "uuid": "bb7a4853-d481-4d54-8e8d-5fadbbe0eca5",
            "name": "AlBatinahNorth-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/a8b17140-bacb-410f-b1c7-8d7300ea8bd4/?format=api",
            "uuid": "a8b17140-bacb-410f-b1c7-8d7300ea8bd4",
            "name": "AlBatinahSouth-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/6b604443-186d-4454-bea1-b85ab03e2a83/?format=api",
            "uuid": "6b604443-186d-4454-bea1-b85ab03e2a83",
            "name": "AlBuraymi-Oman"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/6e852673-6f78-46c2-abd3-b7b71867a2ba/?format=api",
            "uuid": "6e852673-6f78-46c2-abd3-b7b71867a2ba",
            "name": "AlDakhlia-Oman"
        }
    ]
}