Skip to content

Query label

GET /label/<labelId>?fields=...

Description

Query label details.

Path parameters

Param Description
labelId Label Id.

Query parameters

Param Default Description
fields all fields Fields to return (see fields below for all available fields).

Fields

Field Return type Description
id int Label Id.
name string Label name.
color string One of Steel, Olive, Mauve, Emerald, Orange, Magenta or InfraSonarBlue.
description string Label description.
ownerId int Container Id where the label is created.

Return codes

Error code Reason
200 Success.
400 Unknown field.
401 Invalid or missing token.
403 Insufficient permissions (required: API+READ).
404 Label not found.

Example

Curl request: 

curl \
    -X GET 'https://api.infrasonar.com/label/123?fields=name,color' \
    -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'

Response: 

{
    "name": "windows",
    "color": "InfraSonarBlue"
}