Back to explore

storage

Lists

Credits: 0.000001

Create

POST /v1/lists/Create

Create a new list

Request

itemsarray

list items

namestring

list name

Response

listobject

The created list

Request

Response

{
    "list": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:33:03+01:00",
        "name": "New List",
        "items": [
            "This is my list"
        ]
    }
}

Credits: 0.000001

Delete

POST /v1/lists/Delete

Delete a list

Request

idstring

specify the id of the list

Response

listobject

Request

Response

{
    "list": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:50:20+01:00",
        "name": "Update List",
        "items": [
            "Updated list text"
        ]
    }
}

Credits: 0.000001

Events

POST /v1/lists/Events

Subscribe to lists events

Request

idstring

optionally specify a list id

Response

eventstring

the event which occured; create, delete, update

listobject

the list which the operation occured on

Request

Response

{
    "event": "deleted",
    "list": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:50:20+01:00",
        "name": "Update List",
        "items": [
            "Updated list text"
        ]
    }
}

Credits: 0.000001

List

POST /v1/lists/List

List all the lists

Request

{}

Response

listsarray

the list of lists

Request

Response

{
    "lists": [
        {
            "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
            "created": "2021-09-29T13:33:03+01:00",
            "updated": "2021-09-29T13:33:03+01:00",
            "name": "New List",
            "items": [
                "This is my list"
            ]
        }
    ]
}

Credits: 0.000001

Read

POST /v1/lists/Read

Read a list

Request

idstring

the list id

Response

listobject

The list

Request

Response

{
    "list": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:33:03+01:00",
        "name": "New List",
        "items": [
            "This is my list"
        ]
    }
}

Credits: 0.000001

Update

POST /v1/lists/Update

Update a list

Request

listobject

Response

listobject

Request

Response

{
    "list": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:50:20+01:00",
        "name": "Update List",
        "items": [
            "Updated list text"
        ]
    }
}