GET api/nkis/{nki}
Gives you a summary of a given NKI
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| nki |
NKI ID |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Summary of NKI
NKIFullDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Logo |
Whether the NKI uses a logo |
boolean |
None. |
| Created |
Timestamp for NKI creation |
date |
None. |
| Modified |
Timestamp for last modification of NKI |
date |
None. |
| ID |
NKI ID |
integer |
Required |
| Header |
NKI title |
string |
Required String length: inclusive between 0 and 150 |
| WelcomeText |
NKI introduction text |
string |
None. |
| ThankYouText |
NKI completed text |
string |
None. |
| TextColor |
Color of NKI text, hexadecimal (ex. #333333) |
string |
Matching regular expression pattern: ^#([A-Fa-f0-9]{6})$ |
| BackgroundColor |
Color of NKI background, hexadecimal (ex. #eeeeee) |
string |
Matching regular expression pattern: ^#([A-Fa-f0-9]{6})$ |
| ButtonColor |
Color of NKI buttons, hexadecimal (ex. #a1c775) |
string |
Matching regular expression pattern: ^#([A-Fa-f0-9]{6})$ |
| Name |
NKI name |
string |
Required String length: inclusive between 0 and 150 |
Response Formats
application/json, text/json
Sample:
{
"Logo": true,
"Created": "2025-12-16T03:28:06.8910292+00:00",
"Modified": "2025-12-16T03:28:06.8910292+00:00",
"ID": 2,
"Header": "sample string 3",
"WelcomeText": "sample string 4",
"ThankYouText": "sample string 5",
"TextColor": "sample string 6",
"BackgroundColor": "sample string 7",
"ButtonColor": "sample string 8",
"Name": "sample string 9"
}