Skip to content
calternal docs

List file assignments

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

Lists the file assignments. 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/items. Inputs: folder, limit, cursor, paths. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
folder
string

Home-relative folder. Empty or omitted lists all tagged Files and Photos.

limit
integer
cursor
integer
paths
Array<string>

Exact Home-relative paths for a bounded batch lookup.

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

One page of file and Photo assignments below a folder.

object
assignments
required
Array<object>
object
path
required
string
tags
required
Array<string>
next_cursor
integer | null
Examplegenerated
{
  "assignments": [
    {
      "path": "example",
      "tags": [
        "example"
      ]
    }
  ],
  "next_cursor": 1
}

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"
  }
}