• Actions
    • Applications
    • Batch
    • Boards
    • Cards
    • Checklists
    • CustomFields
    • Emoji
    • Enterprises
    • Labels
    • Lists
    • Members
    • Notifications
    • Organizations
    • Plugins
    • Tokens
    • Webhooks
    Cloud
    Trello / Reference / REST API

    Lists

    Postman Collection
    OpenAPI
    GET

    Get a List

    Get information about a List

    Request

    Path parameters

    id

    string

    Required

    Query parameters

    fields

    string

    Responses

    Success

    GET/lists/{id}
    1 2 curl --request GET \ --url 'https://api.trello.com/1/lists/{id}?key=APIKey&token=APIToken'
    PUT

    Update a List

    Update the properties of a List

    Request

    Path parameters

    id

    string

    Required

    Query parameters

    name

    string

    closed

    boolean

    idBoard

    TrelloID

    pos

    oneOf [number, string]

    subscribed

    boolean

    Responses

    Success

    PUT/lists/{id}
    1 2 curl --request PUT \ --url 'https://api.trello.com/1/lists/{id}?key=APIKey&token=APIToken'
    POST

    Create a new List

    Create a new List on a Board

    Request

    Query parameters

    name

    string

    Required
    idBoard

    TrelloID

    Required
    idListSource

    TrelloID

    pos

    oneOf [number, string]

    Responses

    Success

    POST/lists
    1 2 curl --request POST \ --url 'https://api.trello.com/1/lists?name={name}&idBoard=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'
    POST

    Archive all Cards in List

    Archive all cards in a list

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    POST/lists/{id}/archiveAllCards
    1 2 curl --request POST \ --url 'https://api.trello.com/1/lists/{id}/archiveAllCards?key=APIKey&token=APIToken'
    POST

    Move all Cards in List

    Move all Cards in a List

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    idBoard

    TrelloID

    Required
    idList

    TrelloID

    Required

    Responses

    Success

    POST/lists/{id}/moveAllCards
    1 2 curl --request POST \ --url 'https://api.trello.com/1/lists/{id}/moveAllCards?idBoard=5abbe4b7ddc1b351ef961414&idList=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'
    PUT

    Archive or unarchive a list

    Archive or unarchive a list

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    value

    TrelloID

    Responses

    Success

    PUT/lists/{id}/closed
    1 2 curl --request PUT \ --url 'https://api.trello.com/1/lists/{id}/closed?key=APIKey&token=APIToken'
    PUT

    Move List to Board

    Move a List to a different Board

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    value

    TrelloID

    Required

    Responses

    Success

    PUT/lists/{id}/idBoard
    1 2 curl --request PUT \ --url 'https://api.trello.com/1/lists/{id}/idBoard?value=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'
    PUT

    Update a field on a List

    Rename a list

    Request

    Path parameters

    id

    TrelloID

    Required
    field

    string

    Required

    Query parameters

    value

    oneOf [string, number, string, boolean]

    Responses

    Success

    PUT/lists/{id}/{field}
    1 2 curl --request PUT \ --url 'https://api.trello.com/1/lists/{id}/{field}?key=APIKey&token=APIToken'
    GET

    Get Actions for a List

    Get the Actions on a List

    Request

    Path parameters

    id

    string

    Required

    Query parameters

    filter

    string

    Responses

    Success

    GET/lists/{id}/actions
    1 2 curl --request GET \ --url 'https://api.trello.com/1/lists/{id}/actions?key=APIKey&token=APIToken'
    GET

    Get the Board a List is on

    Get the board a list is on

    Request

    Path parameters

    id

    string

    Required

    Query parameters

    fields

    string

    Responses

    Success

    GET/lists/{id}/board
    1 2 curl --request GET \ --url 'https://api.trello.com/1/lists/{id}/board?key=APIKey&token=APIToken'
    GET

    Get Cards in a List

    List the cards in a list

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    application/json

    array<Card>

    GET/lists/{id}/cards
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/lists/{id}/cards?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 [ { "id": "5abbe4b7ddc1b351ef961414", "address": "<string>", "badges": { "attachmentsByType": { "trello": { "board": 2154, "card": 2154 } }, "location": true, "votes": 2154, "viewingMemberVoted": false, "subscribed": false, "fogbugz": "<string>", "checkItems": 0, "checkItemsChecked": 0, "comments": 0, "attachments": 0, "description": true, "due": "<string>", "start": "<string>", "dueComplete": true }, "checkItemStates": [ "<string>" ], "closed": true, "coordinates": "<string>", "creationMethod": "<string>", "dateLastActivity": "2019-09-16T16:19:17.156Z", "desc": "πŸ‘‹Hey there,\n\nTrello's Platform team uses this board to keep developers up-to-date.", "descData": { "emoji": {} }, "due": "<string>", "dueReminder": "<string>", "idBoard": "5abbe4b7ddc1b351ef961414", "idChecklists": [ { "id": "5abbe4b7ddc1b351ef961414" } ], "idLabels": [ { "id": "5abbe4b7ddc1b351ef961414", "idBoard": "5abbe4b7ddc1b351ef961414", "name": "Overdue", "color": "yellow" } ], "idList": "5abbe4b7ddc1b351ef961414", "idMembers": [ "5abbe4b7ddc1b351ef961414" ], "idMembersVoted": [ "5abbe4b7ddc1b351ef961414" ], "idShort": 2154, "labels": [ "5abbe4b7ddc1b351ef961414" ], "limits": { "attachments": { "perBoard": {} } }, "locationName": "<string>", "manualCoverAttachment": false, "name": "πŸ‘‹ What? Why? How?", "pos": 65535, "shortLink": "H0TZyzbK", "shortUrl": "https://trello.com/c/H0TZyzbK", "subscribed": false, "url": "https://trello.com/c/H0TZyzbK/4-%F0%9F%91%8B-what-why-how", "cover": { "color": "yellow", "idUploadedBackground": true, "size": "normal", "brightness": "light", "isTemplate": false } } ]

    Rate this page: