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

    Tokens

    Postman Collection
    OpenAPI
    GET

    Get a Token

    Retrieve information about a token.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    token

    string

    Required

    Query parameters

    fields

    TokenFields

    webhooks

    boolean

    Responses

    Success

    application/json

    Token
    GET/tokens/{token}
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/tokens/{token}?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "id": "5abbe4b7ddc1b351ef961414", "identifier": "App Name", "idMember": "5abbe4b7ddc1b351ef961414", "dateCreated": "2019-10-16T14:27:17.304Z", "dateExpires": "<string>", "permissions": [ { "idModel": "5abbe4b7ddc1b351ef961414", "modelType": "board", "read": true, "write": true } ] }
    GET

    Get Token's Member

    Retrieve information about a token's owner by token.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    token

    string

    Required

    Query parameters

    fields

    MemberFields

    Responses

    Success

    application/json

    Member
    GET/tokens/{token}/member
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/tokens/{token}/member?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 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 { "id": "5abbe4b7ddc1b351ef961414", "activityBlocked": false, "avatarHash": "fc8faaaee46666a4eb8b626c08933e16", "avatarUrl": "https://trello-avatars.s3.amazonaws.com/fc8faaaee46666a4eb8b626c08933e16", "bio": "👋 I'm a developer advocate at Trello!", "bioData": { "emoji": {} }, "confirmed": true, "fullName": "Bentley Cook", "idEnterprise": "5abbe4b7ddc1b351ef961414", "idEnterprisesDeactivated": [ "<string>" ], "idMemberReferrer": "5abbe4b7ddc1b351ef961414", "idPremOrgsAdmin": [ "5abbe4b7ddc1b351ef961414" ], "initials": "BC", "memberType": "normal", "nonPublic": { "fullName": "Bentley Cook", "initials": "BC", "avatarUrl": "https://trello-members.s3.amazonaws.com/5b02e7f4e1facdc393169f9d/db2adf80c2e6c26b76e1f10400eb4c45", "avatarHash": "db2adf80c2e6c26b76e1f10400eb4c45" }, "nonPublicAvailable": false, "products": [ 2154 ], "url": "https://trello.com/bentleycook", "username": "bentleycook", "status": "disconnected", "aaEmail": "<string>", "aaEnrolledDate": "<string>", "aaId": "<string>", "avatarSource": "gravatar", "email": "bcook@atlassian.com", "gravatarHash": "0a1e804f6e35a65ae5e1f7ef4c92471c", "idBoards": [ "5abbe4b7ddc1b351ef961414" ], "idOrganizations": [ "5abbe4b7ddc1b351ef961414" ], "idEnterprisesAdmin": [ "5abbe4b7ddc1b351ef961414" ], "limits": { "status": "ok", "disableAt": 36000, "warnAt": 32400 }, "loginTypes": [ "password" ], "marketingOptIn": { "optedIn": false, "date": "2018-04-26T17:03:25.155Z" }, "messagesDismissed": { "name": "ad-security-features", "count": "<string>", "lastDismissed": "2019-03-11T20:19:46.809Z", "_id": "5abbe4b7ddc1b351ef961414" }, "oneTimeMessagesDismissed": [ "<string>" ], "prefs": { "timezoneInfo": { "offsetCurrent": 360, "timezoneCurrent": "CST", "offsetNext": 300, "dateNext": "2020-03-08T08:00:00.000Z", "timezoneNext": "CDT" }, "privacy": { "fullName": "public", "avatar": "public" }, "sendSummaries": true, "minutesBetweenSummaries": 60, "minutesBeforeDeadlineToNotify": 1440, "colorBlind": true, "locale": "en-AU", "timezone": "America/Chicago", "twoFactor": { "enabled": true, "needsNewBackups": false } }, "trophies": [ "<string>" ], "uploadedAvatarHash": "dac3ad49ff117829dd63a79bb2ea3426", "uploadedAvatarUrl": "https://trello-avatars.s3.amazonaws.com/dac3ad49ff117829dd63a79bb2ea3426", "premiumFeatures": [ "<string>" ], "isAaMastered": false, "ixUpdate": 2154, "idBoardsPinned": [ "5abbe4b7ddc1b351ef961414" ] }
    GET

    Get Webhooks for Token

    Retrieve all webhooks created with a Token.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    token

    string

    Required

    Responses

    Success

    application/json

    array<Webhook>

    GET/tokens/{token}/webhooks
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/tokens/{token}/webhooks?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 [ { "id": "5abbe4b7ddc1b351ef961414", "description": "Board Webhook", "idModel": "5abbe4b7ddc1b351ef961414", "callbackURL": "https://mywebhookurl.com/?type=board", "active": true, "consecutiveFailures": 0, "firstConsecutiveFailDate": "<string>" } ]
    POST

    Create Webhooks for Token

    Create a new webhook for a Token.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    token

    string

    Required

    Query parameters

    description

    string

    callbackURL

    string

    Required
    idModel

    TrelloID

    Required

    Responses

    Success

    application/json

    Webhook
    POST/tokens/{token}/webhooks
    1 2 3 curl --request POST \ --url 'https://api.trello.com/1/tokens/{token}/webhooks?callbackURL={callbackURL}&idModel=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 { "id": "5abbe4b7ddc1b351ef961414", "description": "Board Webhook", "idModel": "5abbe4b7ddc1b351ef961414", "callbackURL": "https://mywebhookurl.com/?type=board", "active": true, "consecutiveFailures": 0, "firstConsecutiveFailDate": "<string>" }
    GET

    Get a Webhook belonging to a Token

    Retrieve a webhook created with a Token.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    token

    string

    Required
    idWebhook

    TrelloID

    Required

    Responses

    Success

    application/json

    Webhook
    GET/tokens/{token}/webhooks/{idWebhook}
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/tokens/{token}/webhooks/{idWebhook}?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 { "id": "5abbe4b7ddc1b351ef961414", "description": "Board Webhook", "idModel": "5abbe4b7ddc1b351ef961414", "callbackURL": "https://mywebhookurl.com/?type=board", "active": true, "consecutiveFailures": 0, "firstConsecutiveFailDate": "<string>" }
    PUT

    Update a Webhook created by Token

    Update a Webhook created by Token

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    token

    string

    Required
    idWebhook

    TrelloID

    Required

    Query parameters

    description

    string

    callbackURL

    string

    idModel

    TrelloID

    Responses

    Success

    PUT/tokens/{token}/webhooks/{idWebhook}
    1 2 curl --request PUT \ --url 'https://api.trello.com/1/tokens/{token}/webhooks/{idWebhook}?key=APIKey&token=APIToken'
    DEL

    Delete a Webhook created by Token

    Delete a webhook created with given token.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    token

    string

    Required
    idWebhook

    TrelloID

    Required

    Responses

    Success

    DEL/tokens/{token}/webhooks/{idWebhook}
    1 2 curl --request DELETE \ --url 'https://api.trello.com/1/tokens/{token}/webhooks/{idWebhook}?key=APIKey&token=APIToken'
    DEL

    Delete a Token

    Delete a token.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    token

    string

    Required

    Responses

    Success

    DEL/tokens/{token}/
    1 2 curl --request DELETE \ --url 'https://api.trello.com/1/tokens/{token}/?key=APIKey&token=APIToken'

    Rate this page: