API docs by Redocly

Listee API (1.0.0)

Download OpenAPI specification:

License: MIT

Introduction

Welcome to the Listee API documentation. This API allows developers to programmatically access and manipulate task data within the Listee task management platform.

Authentication

All API requests require authentication using an API key. You can obtain an API key from your Listee account settings.

Authorization: Bearer YOUR_API_KEY

Security Requirements

API keys have full access to your Listee account data. Always follow these security best practices:

  • Store API keys as environment variables, never in source code
  • Never commit API keys to version control systems
  • Rotate keys periodically for enhanced security
  • Use IP restrictions where possible in production environments

Rate Limiting

To ensure service stability, the API implements rate limiting. Exceeding these limits will result in 429 Too Many Requests responses. Rate limits are applied per API key.

Endpoints

Categories

Manage your task categories.

Tasks

Create, update, and organize tasks within categories.

Error Handling

Error responses include a JSON body with details:

{
  "error": {
    "code": "error_code",
    "message": "Description of the error",
    "details": { /* Optional: Additional error details */ }
  }
}

Common error codes and their corresponding HTTP status codes:

Error Code HTTP Status Description
bad_request 400 The request was malformed or invalid
unauthorized 401 Authentication is required or failed
forbidden 403 You don't have permission to access this resource
not_found 404 The requested resource was not found
conflict 409 The request conflicts with the current state
validation_error 422 The request data failed validation
too_many_requests 429 You've exceeded the rate limit
internal_error 500 An unexpected server error occurred

Terms of Service

By using the Listee API, you agree to comply with our API Terms of Service. These terms include important information about permitted use, data handling responsibilities, and limitations.

Support

If you have any questions or need assistance with the API, please contact our developer support team at listee@gen-ltd.jp.

Categories

Get all user categories

Authorizations:
ApiKeyHeaderApiKeyBearer

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Create a new category

Authorizations:
ApiKeyHeaderApiKeyBearer
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "kind": "string",
  • "isAlexaEnabled": true,
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get category by ID

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "kind": "string",
  • "isAlexaEnabled": true,
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update category

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "kind": "string",
  • "isAlexaEnabled": true,
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete category

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Tasks

Get all tasks in a category

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ]
}

Create a new task in a category

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
name
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "isChecked": true,
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0"
}

Update task

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>
taskId
required
string <uuid>
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "isChecked": true,
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0"
}

Delete task

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>
taskId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Update task status (checked/unchecked)

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>
taskId
required
string <uuid>
Request Body schema: application/json
required
isChecked
required
boolean

Responses

Request samples

Content type
application/json
{
  • "isChecked": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "isChecked": true,
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0"
}

Reorder tasks within a category

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>
Request Body schema: application/json
required
orderIds
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "orderIds": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Delete multiple tasks from a category

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>
Request Body schema: application/json
required
taskIds
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "taskIds": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Uncheck multiple tasks at once

Marks multiple tasks as unchecked without changing their order in the list

Authorizations:
ApiKeyHeaderApiKeyBearer
path Parameters
categoryId
required
string <uuid>

ID of the category containing the tasks

Request Body schema: application/json
required
taskIds
required
Array of strings <uuid> [ items <uuid > ]

List of task IDs to uncheck

Responses

Request samples

Content type
application/json
{
  • "taskIds": [
    ]
}

Response samples

Content type
application/json
{
  • "taskIds": [
    ]
}

Move tasks from one category to another

Authorizations:
ApiKeyHeaderApiKeyBearer
Request Body schema: application/json
required
taskIds
required
Array of strings <uuid> [ items <uuid > ]
fromCategoryId
required
string <uuid>
toCategoryId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "taskIds": [
    ],
  • "fromCategoryId": "089c8111-d633-4e07-90f6-f3ece70216c9",
  • "toCategoryId": "8a94a34b-01da-4011-a8c1-764573a6ef78"
}

Response samples

Content type
application/json
{
  • "success": true
}