Help & Support
Follow

Custom Fields API Quick Reference

 

Note: Custom Fields are available with Advanced/Premium product editions

 

API Status 

GET /io/status

Returns a JSON response object with status and uptime.

Custom Field Definition 

GET /io/board/:id/customfield

returns a description of the fields along with a count of the number of fields allowed for that account.

PATCH /io/board/:id/customfield

Update custom fields for a board. 

Sample Request Body:

[
    { "op": "add", "path": "/", "value": { "label": "Favorite Color", "type": "text", "helpText": "What color makes you the happiest?" } },
    { "op": "replace", "path": "/10112866592", "value": {
      "index": 1,
      "type": "number",
      "label": "Hours Worked",
      "helpText": "Total number of hours for project."
    } }

]

Custom Field Values 

POST /io/card

Create a card and assign custom fields at that time.

Sample Request Body:

[
    {"op":"replace", "path":"/customFields", "value":[{"fieldId":"10112866592", "value":1.8}]}
]
GET /io/card/:id

return the specified card, including custom fields

API Authentication Tokens 

Our secure endpoints require authentication. API tokens allow users to call these endpoints without exposing your username & password in code. It’s easy to create and manage tokens using a REST api client such as Postman and the following endpoints.

POST /io/auth/token

Create a new token for the authenticated user.

Sample Request Body:

{
    "Description":"my first application"
}

Sample Response:

{
  "id": "10112904973",
  "token": "9f6bfb6021f6b9bc69d2da3649fdc3ede099f16a1a4c6eb6c297ff2bcdd85f5c608188bee49628628d697ebd3979baf6827ef5cd34c90e86f29e88f5c8889f14",
  "description": "my first application",
  "createdOn": "2016-06-26T19:27:47.030Z"
}

Note: your token is encrypted before storing it, and cannot be retrieved once it’s been delivered. Copy your token and keep it safe -- when it’s used in API calls, it represents your personal LeanKit account!

Once a token is created, include it in your requests by adding it to your Authorization header as a “bearer” token:

 Authorization:bearer 9f6bfb6021f6b9bc69d2da3649fdc3ede099f16a1a4c6eb6c297ff2bcdd85f5c608188bee49628628d697ebd3979baf6827ef5cd34c90e86f29e88f5c8889f14
GET /io/auth/token

Return existing tokens for the authenticated user.

Sample Request Body:

{
  "tokens": [
    {
      "id": "10112904973",
      "description": "my first application",
      "createdOn": "2016-02-26T19:27:47Z"
    }
  ]
}
DELETE /io/auth/token/:id

Invalidate and delete the specified token.

 

 

 

 

 

 

Doc ID: 1191979652

Have more questions? Submit a request