Get Highlight

GET

/highlights/{object_id}

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (Highlight)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Highlight

Example:

Highlight

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "Highlight",
        "attributes": {
            "collectionItemId": "string",
            "color": "string",
            "range": "string",
            "summary": "string"
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Modified at 2025-07-08 10:51:21

List Highlights

Update Highlight