Help & Support

Card ID Settings


LeanKit has a number of Card ID settings. This functionality is available in LeanKit's higher editions. These can be set for each board by a person with Manager privileges or higher for that board or Administrator privileges for the LeanKit account. Card ID settings  can be accessed by clicking the gear icon in the upper right corner of the screen, selecting the Board Settings option, and then the Card ID Settings tab. 


Display external Card ID field in card edit dialog

The first option in the list determines whether the Card ID field will display on the Details tab in cards on this board. If the field is turned on, it works like other text entry fields on the card. If this box is unchecked, the Card ID field is still available to populate via API. This is a great option when you want to store something in this field to use as a reference for integrations and don't want it to be at-risk of being changed accidentally by a user.

Allow Duplicate Card IDs

Selecting this option allows users to enter the same text into the Card ID field on multiple cards on this board. If you are using this field to store a reference number linking to some other system you would not want to allow duplicated card IDs. If you were using the Card ID field as a simple label, for example to mark a number of cards as being part of the same project, then you would want to allow duplicates.

Enable Header

Selecting this option turns on the header "stripe" across the top of cards that's usually a darker shade of the main card color. There are three main options for what information should be displayed in the header.

  • Display text from (external) card ID field - If this option is selected, the header will display whatever text is contained in the Card ID field described above.
  • Display LeanKit unique card ID (permalink) - If this option is selected, the header will display the unique, unchanging ID number by which the LeanKit system references the card. This is same number that appears in the permalink that is visible in the lower right corner of the inside of each card. This number is unique no matter which board the card is moved to.
  • Display auto-increment card ID (1, 2, 3 ..) - If this option is selected, the system will begin inserting a number into the Card ID field of each new card you create, e.g. 1, 2, 3, 4, 5. Existing cards will not be updated. If this option is selected and the Card ID field is turned on inside the card, that field will be visible but not editable. Auto-numbering in this way is only unique for the board on which the card is created. If the card is moved to another board later, there may be two cards with the same auto-numbered number.

Display Prefix in front of Card ID

Selecting this option will insert whatever text you place in this box into the header—in front of the text that results from whichever of the options above is selected. For example, let's say the cards on your board represent Salesforce opportunities. You are placing the opportunity ID into the Card ID field (whether manually or by API). You might put SFDC into this prefix field. That way other people looking at the board would see SFDC-12345 in the card header and more clearly understand what the cards represent.

Hyperlink Header Options

You can turn the card header into a hyperlink using the Hyperlink Header Options. You first need to check the box to "Generate link from custom card ID." Once you do this, you'll need to copy or type the link format that will apply to all links on the board. For example, let's say cards on your board represent articles in Zendesk (the system we used to build this support site). The standard link format for a Zendesk article on our site is

The only thing that differs for each article is what comes after that. We represent that with a placeholder{ID}. So what we'll put this into this field in Card ID Settings:{ID}.

Once we save these settings and go to the board the text you type into the Card ID field will replace the {ID}. For example, the link to this specific article on the LeanKit support site (the one you are reading), is So you would type 21660393 and the header of the card would become a link to that page.

If the prefix you entered above is actually part of your standard URL format, e.g. SFDC, you can select the "Include Prefix in URL Option"

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request