Lists
Get list details
Retrieves comprehensive list information, including cards, attachments, and other related data. Requires access to the board.
get/lists/{id}
Request
- Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
- URL: /api/lists/{id}
- Auth: one of:
- HTTP bearer
- API key in header X-Api-Key
Path parameters
idstring required
Example:1357158568008091264
ID of the list to retrieve
Response
List details retrieved successfully
Example response
{
"item": {
"id": "1357158568008091264",
"boardId": "1357158568008091265",
"type": "active",
"position": 65536,
"name": "To Do",
"color": "lagoon-blue",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
},
"included": {
"users": [
{
"id": "1357158568008091264",
"email": "john.doe@example.com",
"role": "admin",
"name": "John Doe",
"username": "john_doe",
"avatar": {
"url": "https://storage.example.com/user-avatars/1357158568008091264/original.jpg",
"thumbnailUrls": {
"cover180": "https://storage.example.com/user-avatars/1357158568008091264/cover-180.jpg"
}
},
"gravatarUrl": "https://www.gravatar.com/avatar/abc123",
"phone": "+1234567890",
"organization": "Acme Corporation",
"language": "en-US",
"apiKeyPrefix": "D89VszVs",
"subscribeToCardWhenCommenting": true,
"enableFavoritesByDefault": true,
"defaultEditorMode": "wysiwyg",
"defaultHomeView": "groupedProjects",
"defaultProjectsOrder": "byDefault",
"lockedFieldNames": [
"email",
"password",
"name"
],
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"cards": [
{
"id": "1357158568008091264",
"boardId": "1357158568008091265",
"listId": "1357158568008091266",
"creatorUserId": "1357158568008091267",
"prevListId": "1357158568008091268",
"coverAttachmentId": "1357158568008091269",
"type": "project",
"position": 65536,
"name": "Implement user authentication",
"description": "Add JWT-based authentication system...",
"dueDate": "2024-01-01T00:00:00.000Z",
"stopwatch": {
"startedAt": "2024-01-01T00:00:00.000Z",
"total": 3600
},
"commentsTotal": 100,
"listChangedAt": "2024-01-01T00:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"isSubscribed": true
}
],
"cardMemberships": [
{
"id": "1357158568008091264",
"cardId": "1357158568008091265",
"userId": "1357158568008091266",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"cardLabels": [
{
"id": "1357158568008091264",
"cardId": "1357158568008091265",
"labelId": "1357158568008091266",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"taskLists": [
{
"id": "1357158568008091264",
"cardId": "1357158568008091265",
"position": 65536,
"name": "Development Tasks",
"showOnFrontOfCard": true,
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"tasks": [
{
"id": "1357158568008091264",
"taskListId": "1357158568008091265",
"linkedCardId": "1357158568008091266",
"assigneeUserId": "1357158568008091267",
"position": 65536,
"name": "Write unit tests",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"attachments": [
{
"id": "1357158568008091264",
"cardId": "1357158568008091265",
"creatorUserId": "1357158568008091266",
"type": "link",
"data": {
"url": "https://google.com/search?q=planka",
"faviconUrl": "https://storage.example.com/favicons/google.com.png"
},
"name": "Important Attachment",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"customFieldGroups": [
{
"id": "1357158568008091264",
"boardId": "1357158568008091265",
"cardId": "1357158568008091266",
"baseCustomFieldGroupId": "1357158568008091267",
"position": 65536,
"name": "Properties",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"customFields": [
{
"id": "1357158568008091264",
"baseCustomFieldGroupId": "1357158568008091265",
"customFieldGroupId": "1357158568008091266",
"position": 65536,
"name": "Priority",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"customFieldValues": [
{
"id": "1357158568008091264",
"cardId": "1357158568008091265",
"customFieldGroupId": "1357158568008091266",
"customFieldId": "1357158568008091267",
"content": "High Priority",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.