Skip to content
calternal docs

Get Tag details

GET
/api/v1/tags/{tag}
curl --request GET \
  --url https://example.com/api/v1/tags/example \
  --header 'Authorization: Bearer <token>'

Returns the Tag details. It requires a signed-in User with the data scope. It can return 400 if the request is invalid, 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/tags/{tag}. Inputs: tag, limit, cursor. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tag
required
string

Query Parameters

Section titled “Query Parameters”
limit
integer
cursor
integer

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
items
required
Array<object>

One tagged object in a Home.

object
id
required
string
kind
required
string
path
required
string
title
string | null
next_cursor
integer | null
tag
required
string
Examplegenerated
{
  "items": [
    {
      "id": "example",
      "kind": "example",
      "path": "example",
      "title": "example"
    }
  ],
  "next_cursor": 1,
  "tag": "example"
}

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}