Skip to content
calternal docs

List items that use a file

GET
/api/v1/notes/used-in
curl --request GET \
  --url 'https://example.com/api/v1/notes/used-in?path=example' \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User with the data scope. Returns the User’s Notes, Tasks, Log entries and Events that use the file, up to 1000 items. Returns 413 when that limit is exceeded. Route: /api/v1/notes/used-in. Inputs: path. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
path
required
string

Responses

Section titled “Responses”

200

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

One stable item that uses a file; date is set only for a Log entry (#620).

object
date
string | null
id
required
string
kind
required

Source types for the Inspector’s file-usage backlinks (#620; DESIGN §34).

string
Allowed values: log event task note
title
required
string
Example
[
  {
    "kind": "log"
  }
]

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

404

Section titled “404”
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"
  }
}

413

Section titled “413”
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"
  }
}