Skip to content
calternal docs

Get Files preferences

GET
/api/v1/files/preferences
curl --request GET \
  --url https://example.com/api/v1/files/preferences \
  --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 preferences are invalid. Route: /api/v1/files/preferences. Inputs: . Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Visibility preferences for ordinary Files listings.

object
show_dot_files
required

Show names that start with U+002E in the User’s Home.

boolean
show_sidecar_files
required

Show paired XMP and Apple AAE sidecar files as separate entries.

boolean
Examplegenerated
{
  "show_dot_files": true,
  "show_sidecar_files": true
}

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