This endpoint is used to check if the API is up and running. It returns a simple JSON response with the status of the API.
request: {} This endpoint does not require any parameters. You can simply make a GET request to the endpoint to check the status of the API.
response: {
status: 200,
message: "API is up and running"
}The response will be a JSON object with a status of 200 and a message indicating that the API is up and running. A status of 500 indicates that the API is down.
This endpoints returns 10 of the lists owned by by the owner of the API key. The lists are returned in the order of creation, with the oldest list being the first in the list. If there are no lists, the response will be an empty array.
The response is paginated, with a maximum of 10 lists per page, if there are more than 10 lists, the response nextToken will be non-null.
If the nextToken is provided in the request, the response will contain the next 10 lists after the list with the nextToken. If the nextToken is not provided, the response will contain the first 10 lists.
request: {
headers: {
authorization: String
},
queryStringParameters: {
nextToken: String | NULL
},
}This endpoint requires the API key to be passed in the authorization header. The nextToken is optional and can be used to fetch the next 25 lists after the list with the nextToken.
response: {
status: 200 | 401 | 502,
message: "Lists Retrieved" | Error Message,
lists: List[],
nextToken: String | NULL
}This endpoint is used to add a new list to the database. The request body should contain the name of the list. The response will contain the newly created list object.
request: {
headers: {
authorization: String
},
body: {
listName: String
},
}This endpoint requires the API key to be passed in the authorization header. The request body should contain the name of the list.
response: {
status: 200 | 400 | 401 | 502,
message: "List Created." | Error Message,
list: List,
}This endpoint is used to delete a list and all of the respective list items from the database. The request body should contain the id of the list to be deleted. The response will contain a message indicating that the list has been deleted and the list that was deleted.
request: {
headers: {
authorization: String
},
queryStringParameters: {
listId: String
},
}This endpoint requires the API key to be passed in the authorization header. The query parameters should contain the id of the list to be deleted.
response: {
status: 200 | 400 | 401 | 403 | 404 | 502,
message: "List Deleted." | Error Message,
list: List | NULL,
}This endpoint is used to get the items in a list. The request query parameters should contain the id of the list. The maximum number of items returned is 25. The response will contain the items in the list and the nextToken if there are more items to be fetched.
request: {
headers: {
authorization: String
},
queryStringParameters: {
listId: String,
nextToken: String | NULL
},
}This endpoint requires the API key to be passed in the authorization header. The query parameters should contain the id of the list to fetch the items from. The nextToken is optional and can be used to fetch the next 25 items after the item with the nextToken.
response: {
status: 200 | 400 | 401 | 403 | 404 | 502,
message: "List Items Retrieved" | Error Message,
listItems: ListItem[],
nextToken: String | NULL
}This endpoint is used to add a new item to a list. The request body should contain the id of the list and the name of the item. The response will contain the newly created list item object.
request: {
headers: {
authorization: String
},
body: {
listId: String,
itemName: String
},
}This endpoint requires the API key to be passed in the authorization header. The request body should contain the id of the list and the name of the item.
response: {
status: 200 | 400 | 401 | 403 | 404 | 502,
message: "List Item Created" | Error Message,
listItem: ListItem,
}This endpoint is used to set the checked status of a list item. The request query strings should contain the id of the list item and the checked status. The response will contain the updated list item object.
request: {
headers: {
authorization: String
},
queryStringParameters: {
itemId: String,
checked: Boolean
},
}This endpoint requires the API key to be passed in the authorization header. The request query strings should contain the id of the list item and the checked status.
response: {
status: 200 | 400 | 401 | 403 | 404 | 502,
message: "List Item Checked Status Set" | Error Message,
listItem: ListItem,
}This endpoint is used to rename a list item. The request query strings should contain the id of the list item and the new name of the item. The response will contain the updated list item object.
request: {
headers: {
authorization: String
},
queryStringParameters: {
itemId: String,
newItemName: String
},
}This endpoint requires the API key to be passed in the authorization header. The request query strings should contain the id of the list item to update and the new name of the item.
response: {
status: 200 | 400 | 401 | 403 | 404 | 502,
message: "List Item Renamed." | Error Message,
listItem: ListItem,
}This endpoint is used to delete a list item from the database. The request query strings should contain the id of the list item to be deleted. The response will contain a message indicating that the list item has been deleted and the list item that was deleted.
request: {
headers: {
authorization: String
},
queryStringParameters: {
itemId: String,
},
}This endpoint requires the API key to be passed in the authorization header. The query parameters should contain the id of the list item to be deleted.
response: {
status: 200 | 400 | 401 | 403 | 404 | 502,
message: "List Item Deleted" | Error Message,
listItem: ListItem,
}