Trello Developer

Trello Developer

    Rate this page:

    Actions

    Get an Action

    GET /1/actions/{id}

    Get an Action

    Request

    Path parameters
    id Required

    string

    The ID of the Action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    display

    boolean

    Default: true
    entities

    boolean

    Default: false
    fields

    string

    all or a comma-separated list of action fields

    Default: all
    member

    boolean

    Default: true
    member_fields

    string

    all or a comma-separated list of member fields

    Default: avatarHash,fullName,initials,username
    memberCreator

    boolean

    Whether to include the member object for the creator of the action

    Default: true
    memberCreator_fields

    string

    all or a comma-separated list of member fields

    Default: avatarHash,fullName,initials,username

    Example

    1
2
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Update an Action

    PUT /1/actions/{id}

    Update a specific Action. Only comment actions can be updated. Used to edit the content of a comment.

    Request

    Path parameters
    id Required

    string

    The ID of the Action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    text Required

    string

    The new text for the comment

    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/actions/{id}?text={text}&key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Delete an Action

    DELETE /1/actions/{id}

    Delete a specific action. Only comment actions can be deleted.

    Request

    Path parameters
    id Required

    string

    The ID of the Action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$

    Example

    1
2
    curl --request DELETE \
  --url 'https://api.trello.com/1/actions/{id}'

    Responses

    Success

    A schema has not been defined for this response code.

    Get a specific field on an Action

    GET /1/actions/{id}/{field}

    Get a specific property of an action

    Request

    Path parameters
    id Required

    string

    The ID of the Action

    Pattern: ^[0-9a-fA-F]{32}$
    field Required

    string

    An action field

    Valid values: id, idMemberCreator, data, type, date, limits, display, memberCreator

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/{field}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Action

    Get the Board for an Action

    GET /1/actions/{id}/board

    Get the Board for an Action

    Request

    Path parameters
    id Required

    string

    The ID of the action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    fields

    string

    all or a comma-separated list of board fields

    Valid values: id, name, desc, descData, closed, idOrganization, pinned, url, shortUrl, prefs ...(Show more)

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/board?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Board

    Get the Card for an Action

    GET /1/actions/{id}/card

    Get the card for an action

    Request

    Path parameters
    id Required

    string

    The ID of the action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    fields

    string

    all or a comma-separated list of card fields

    Valid values: id, address, badges, checkItemStates, closed, coordinates, creationMethod, dueComplete, dateLastActivity, desc ...(Show more)

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/card?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Card

    Get the List for an Action

    GET /1/actions/{id}/list

    Get the List for an Action

    Request

    Path parameters
    id Required

    string

    The ID of the action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    fields

    string

    all or a comma-separated list of list fields

    Valid values: id

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/list?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    List

    Get the Member of an Action

    GET /1/actions/{id}/member

    Gets the member of an action (not the creator)

    Request

    Path parameters
    id Required

    string

    The ID of the Action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    fields

    string

    all or a comma-separated list of member fields

    Valid values: id

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/member?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Member

    Get the Member Creator of an Action

    GET /1/actions/{id}/memberCreator

    Get the Member who created the Action

    Request

    Path parameters
    id Required

    string

    The ID of the Action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    fields

    string

    all or a comma-separated list of member fields

    Valid values: id

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/memberCreator?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Member

    Get the Organization of an Action

    GET /1/actions/{id}/organization

    Get the Organization of an Action

    Request

    Path parameters
    id Required

    string

    The ID of the action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    fields

    string

    all or a comma-separated list of organization fields

    Valid values: id, name

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/organization?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Organization

    Update a Comment Action

    PUT /1/actions/{id}/text

    Update a comment action

    Request

    Path parameters
    id Required

    string

    The ID of the action to update

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    value Required

    string

    The new text for the comment

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/actions/{id}/text?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value={value}'

    Responses

    Success

    A schema has not been defined for this response code.

    Get Action's Reactions

    GET /1/actions/{idAction}/reactions

    List reactions for an action

    Request

    Path parameters
    idAction Required

    string

    The ID of the action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{64}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    member

    boolean

    Whether to load the member as a nested resource. See Members Nested Resource

    Default: true
    emoji

    boolean

    Whether to load the emoji as a nested resource.

    Default: true

    Example

    1
2
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{idAction}/reactions?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Create Reaction for Action

    POST /1/actions/{idAction}/reactions

    Adds a new reaction to an action

    Request

    Path parameters
    idAction Required

    string

    The ID of the action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{64}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    Body parameters
    shortName

    string

    The primary shortName of the emoji to add. See /emoji

    skinVariation

    string

    The skinVariation of the emoji to add. See /emoji

    native

    string

    The emoji to add as a native unicode emoji. See /emoji

    unified

    string

    The unified value of the emoji to add. See /emoji

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/actions/{idAction}/reactions'

    Responses

    Success

    A schema has not been defined for this response code.

    Get Action's Reaction

    GET /1/actions/{idAction}/reactions/{id}

    Get information for a reaction

    Request

    Path parameters
    idAction Required

    string

    The ID of the Action

    Pattern: ^[0-9a-fA-F]{32}$
    id Required

    string

    The ID of the reaction

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    member

    boolean

    Whether to load the member as a nested resource. See Members Nested Resource

    Default: true
    emoji

    boolean

    Whether to load the emoji as a nested resource.

    Default: true

    Example

    1
2
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{idAction}/reactions/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Delete Action's Reaction

    DELETE /1/actions/{idAction}/reactions/{id}

    Deletes a reaction

    Request

    Path parameters
    idAction Required

    string

    The ID of the Action

    Pattern: ^[0-9a-fA-F]{32}$
    id Required

    string

    The ID of the reaction

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$

    Example

    1
2
    curl --request DELETE \
  --url 'https://api.trello.com/1/actions/{idAction}/reactions/{id}'

    Responses

    Success

    A schema has not been defined for this response code.

    List Action's summary of Reactions

    GET /1/actions/{idAction}/reactionsSummary

    List a summary of all reactions for an action

    Request

    Path parameters
    idAction Required

    string

    The ID of the action

    Pattern: ^[0-9a-fA-F]{32}$
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$

    Example

    1
2
    curl --request GET \
  --url 'https://api.trello.com/1/actions/{idAction}/reactionsSummary?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Rate this page: