Skip to main content
GET
List the accessible Library file catalog

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

filters
object

Advanced filter tree as JSON or its JSON-encoded query-string representation, up to20000 bytes before decoding. Discover available fields/options from Library filter metadata. Root must be a group; at most40 nodes and4 nested levels, distinct nonempty IDs. Nonroot groups cannot be empty. Rule path contains one available field ID; values follow that field type/options, at most50 items. Range values contain two ordered values. Dates are real YYYY-MM-DD values. Recipient text fields do not support ends_with.

media_only
boolean

Media only. Validation: boolean.

search_mode
enum<string>

Search mode. Validation: in:filename,content.

Available options:
filename,
content
search
string | null

Search. Validation: nullable|string|max:200.

Maximum string length: 200
record
string | null

Record. Validation: nullable|string.

Pattern: ^(entity|donor):[1-9][0-9]*$
source
enum<string> | null

Source. Validation: nullable|in:records,library,drive,mailings,trips,donations,activities,collaboration,stories,messages,reports.

Available options:
records,
library,
drive,
mailings,
trips,
donations,
activities,
collaboration,
stories,
messages,
reports,
null
type
enum<string> | null

Type.

Available options:
image,
pdf,
document,
spreadsheet,
video,
audio,
archive,
other,
null
scope
enum<string> | null

Scope. Validation: nullable|in:all,recent,starred.

Available options:
all,
recent,
starred,
null
collection_id
integer | null

Collection id. Validation: nullable|integer|min:1.

Required range: x >= 1
sort
enum<string>

Sort. Validation: in:name,modified,size,type.

Available options:
name,
modified,
size,
type
direction
enum<string>

Direction. Validation: in:asc,desc.

Available options:
asc,
desc
page
integer

Page. Validation: integer|min:1|max:100000.

Required range: 1 <= x <= 100000
limit
integer

Limit. Validation: integer|min:1|max:100.

Required range: 1 <= x <= 100

Response

List the accessible Library file catalog response.

data
object[]
meta
object