Trello Developer

Trello Developer

    Rate this page:

    Tokens

    Get a Token

    GET /1/tokens/{token}

    Retrieve information about a token.

    Request

    Path parameters
    token Required

    string

    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 dateCreated, dateExpires, idMember, identifier, permissions

    Valid values: identifier, idMember, dateCreated, dateExpires, permissions

    webhooks

    boolean

    Determines whether to include webhooks.

    Default: false

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Token

    Get Token's Member

    GET /1/tokens/{token}/member

    Retrieve information about a token's owner by token.

    Request

    Path parameters
    token Required

    string

    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 valid fields for Member Object.

    Valid values: id

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Member

    Get Webhooks for Token

    GET /1/tokens/{token}/webhooks

    Retrieve all webhooks created with a Token.

    Request

    Path parameters
    token Required

    string

    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/tokens/{token}/webhooks' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Array<Webhook>

    Create Webhooks for Token

    POST /1/tokens/{token}/webhooks

    Create a new webhook for a Token.

    Request

    Path parameters
    token Required

    string

    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}$
    description

    string

    A description to be displayed when retrieving information about the webhook.

    callbackURL Required

    string

    The URL that the webhook should POST information to.

    Format: url
    idModel Required

    string

    ID of the object to create a webhook on.

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

    Example

    1
2
3
    curl --request POST \
  --url 'https://api.trello.com/1/tokens/{token}/webhooks?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&callbackURL={callbackURL}&idModel=5abbe4b7ddc1b351ef961414' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Webhook

    Get a Webhook belonging to a Token

    GET /1/tokens/{token}/webhooks/{idWebhook}

    Retrieve a webhook created with a Token.

    Request

    Path parameters
    token Required

    string

    idWebhook Required

    string

    ID of the Webhooks to retrieve.

    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
3
    curl --request GET \
  --url 'https://api.trello.com/1/tokens/{token}/webhooks/{idWebhook}' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Webhook

    Update a Webhook created by Token

    PUT /1/tokens/{token}/webhooks/{idWebhook}

    Update a Webhook created by Token

    Request

    Path parameters
    token Required

    string

    idWebhook Required

    string

    ID of the Webhooks to retrieve.

    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}$
    description

    string

    A description to be displayed when retrieving information about the webhook.

    callbackURL

    string

    The URL that the webhook should POST information to.

    Format: url
    idModel

    string

    ID of the object that the webhook is on.

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Delete a Webhook created by Token

    DELETE /1/tokens/{token}/webhooks/{idWebhook}

    Delete a webhook created with given token.

    Request

    Path parameters
    token Required

    string

    idWebhook Required

    string

    ID of the Webhooks to retrieve.

    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/tokens/{token}/webhooks/{idWebhook}'

    Responses

    Success

    A schema has not been defined for this response code.

    Delete a Token

    DELETE /1/tokens/{token}/

    Delete a token.

    Request

    Path parameters
    token Required

    string

    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/tokens/{token}/?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Rate this page: