Skip to content
calternal docs

Get pinned Files items

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

Requires a signed-in User with the data scope. It returns 403 when access is denied or 409 when the saved pin list cannot be read. Route: /api/v1/files/pins. Inputs: . Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

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

True when the item is a folder.

boolean
id
required

Stable Files item identity. It does not change when the item moves or is renamed.

string
name
required

Cached name shown until the Files Index refreshes it.

string
path
required

Last known Home-relative path. It is display metadata, not authority.

string
revision
required

Revision used for compare-and-swap updates.

integer format: int64
Examplegenerated
{
  "pins": [
    {
      "dir": true,
      "id": "example",
      "name": "example",
      "path": "example"
    }
  ],
  "revision": 1
}

403

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

409

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