Skip to main content

Uniphore Customer Portal

Get Annotation Headers

Get a list of the annotation headers in your system, you might want to get this list in order to add or update an annotation, or if you want to add an annotation header but want to check that there isn't a similar annotation already in your system.

Endpoint

Method: GET

URL: /annotation/header

Response and Error Code

Response Code

Condition

200

OK

Response Parameter

Parameter Name

Data Type

Description

id

Integer

The ID of the annotation header, this is unique to each specific annotation header and is auto-generated when the annotation header is created.

header

String

The name of the annotation header, this is what will be used as part of the actual annotations.

enabled

Boolean

Shows if the annotation header is enabled (true) or disabled (parameter will not be displayed if false) for use in your system.

Sample Response
{
  "annotationHeaders": [{
    "id": "9",
    "header": "Example Header 1",
    "enabled": true
  }, {
    "id": "44",
    "header": "Example Header 2",
  }]
}
In this section: