> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # List the accessible Library file catalog > Uses the current tenant and Library/linked-record permissions. Private preferences and collections belong to the current user. Mutations are unavailable in support sessions. Combines native record uploads, canonical Library documents, Drive and supported message/export sources. Content search uses current published analysis; filename search is the default. Source counts may be null while legacy message projection totals are unavailable. ## OpenAPI ````yaml get /admin/workspace-library/files openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity commitment relationships, lifecycle transitions, and commitment-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Events description: >- Event setup, invitations, registration, ticketing, attendance and event reporting. - name: Journeys description: >- Journey graphs, activation, enrollment, message templates and event follow-up automations. - name: Tasks description: Workspace tasks, assignments, saved task views and record collaboration. - name: Fundraising description: >- Fundraising portfolios, stewardship plans, giving anniversaries and personal donor follow-up. - name: Impact Stories description: Story intake, review, assets, consent and publication workflows. - name: Integrations description: Workspace integration connections, mappings, synchronization and recovery. - name: Email Calendar description: Connected email/calendar accounts and donor interactions. - name: Spaces description: Workspace Spaces and collaborative Pages. - name: Library description: Workspace documents, source connections, files and analysis. - name: Intelligence description: Donor intelligence and Tali workspace workflows. - name: Automation description: >- V3 automation primitive discovery, input validation, invocation and Zapier contracts. - name: Schema description: V3 model, enum, capability and scope discovery. - name: Zapier description: Zapier automation connections, polling feeds and actions. - name: Files description: Files - name: Client description: Client - name: Payment Gateways description: Payment Gateways - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Recipients description: Recipients - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Settings description: Settings - name: Notifications description: Notifications - name: Participation description: Participation - name: Users description: Users - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User - name: Workspace description: Workspace paths: /admin/workspace-library/files: get: tags: - Library summary: List the accessible Library file catalog description: >- Uses the current tenant and Library/linked-record permissions. Private preferences and collections belong to the current user. Mutations are unavailable in support sessions. Combines native record uploads, canonical Library documents, Drive and supported message/export sources. Content search uses current published analysis; filename search is the default. Source counts may be null while legacy message projection totals are unavailable. operationId: docWorkspaceFileIndexGET parameters: - name: filters in: query description: >- 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. required: false schema: $ref: '#/components/schemas/WorkspaceLibraryFilterNodeDoc' example: id: root type: group combinator: and rules: [] - name: media_only in: query description: Media only. required: false schema: description: 'Validation: `boolean`.' type: boolean example: true - name: search_mode in: query description: Search mode. required: false schema: description: 'Validation: `in:filename,content`.' type: string enum: - filename - content example: filename - name: search in: query description: Search. required: false schema: description: 'Validation: `nullable|string|max:200`.' type: string maxLength: 200 nullable: true example: graduation - name: record in: query description: Record. required: false schema: description: 'Validation: `nullable|string`.' type: string pattern: ^(entity|donor):[1-9][0-9]*$ nullable: true example: entity:123 - name: source in: query description: Source. required: false schema: description: >- Validation: `nullable|in:records,library,drive,mailings,trips,donations,activities,collaboration,stories,messages,reports`. type: string enum: - records - library - drive - mailings - trips - donations - activities - collaboration - stories - messages - reports - null nullable: true example: records - name: type in: query description: Type. required: false schema: type: string enum: - image - pdf - document - spreadsheet - video - audio - archive - other - null nullable: true example: image - name: scope in: query description: Scope. required: false schema: description: 'Validation: `nullable|in:all,recent,starred`.' type: string enum: - all - recent - starred - null nullable: true example: all - name: collection_id in: query description: Collection id. required: false schema: description: 'Validation: `nullable|integer|min:1`.' type: integer minimum: 1 nullable: true example: 1 - name: sort in: query description: Sort. required: false schema: description: 'Validation: `in:name,modified,size,type`.' type: string enum: - name - modified - size - type example: modified - name: direction in: query description: Direction. required: false schema: description: 'Validation: `in:asc,desc`.' type: string enum: - asc - desc example: desc - name: page in: query description: Page. required: false schema: description: 'Validation: `integer|min:1|max:100000`.' type: integer maximum: 100000 minimum: 1 example: 1 - name: limit in: query description: Limit. required: false schema: description: 'Validation: `integer|min:1|max:100`.' type: integer maximum: 100 minimum: 1 example: 40 responses: '200': description: List the accessible Library file catalog response. content: application/json: schema: $ref: '#/components/schemas/WorkspaceCatalogPageDoc' '401': description: Missing or invalid bearer token or API key. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The caller lacks the required permission, resource access or feature availability. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Request validation or a domain constraint failed. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' '503': description: >- The provider or background processing service is temporarily unavailable. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: WorkspaceLibraryFilterNodeDoc: description: >- 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. properties: id: type: string maxLength: 100 minLength: 1 type: type: string enum: - group - rule combinator: type: string enum: - and - or rules: type: array items: $ref: '#/components/schemas/WorkspaceLibraryFilterNodeDoc' path: type: array items: type: string maxItems: 1 minItems: 1 operator: description: >- Operator allowed for this field type; discover fields via filter metadata. Text: contains/not_contains/starts_with/ends_with/is/is_not; numbers: eq/neq/gt/gte/lt/lte/between/not_between; dates: is/is_not/is_before/is_after/is_on_or_before/is_on_or_after/between/not_between; select: is/is_not/is_any_of/is_none_of; multiselect: has_any_of/has_all_of/has_none_of; all support empty/not_empty. type: string value: oneOf: - type: string - type: number - type: array items: oneOf: - type: string - type: number - type: string enum: - null nullable: true negated: type: boolean type: object WorkspaceCatalogPageDoc: properties: data: type: array items: $ref: '#/components/schemas/WorkspaceCatalogFileDoc' meta: properties: contract_version: type: string example: workspace-file-page.v1 total: type: integer page: type: integer record_context: description: Accessible record identity when a record filter is active. type: object nullable: true additionalProperties: true per_page: type: integer last_page: type: integer source_counts: type: object additionalProperties: type: integer nullable: true type: object type: object UnauthorizedResponse: title: UnauthorizedResponse description: >- Returned with HTTP 401 when the request lacks a valid Passport bearer token, a valid `X-HYS-API-Key`, or a valid session. The body is the simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`. required: - message - status properties: message: description: >- Always the literal string `Unauthorized` from the `auth.api_or_key` middleware. Login endpoints return `Invalid Credentials` instead. type: string example: Unauthorized status: type: string example: error type: object ErrorResponse: title: ErrorResponse description: >- Generic error envelope used by most controllers. Most error responses pair a human-readable `message` with `status: error`. Some endpoints additionally include `errors` (validator errors), `error` (legacy single-error string), `code`, or domain-specific context fields. required: - message properties: message: description: Human-readable error message. type: string example: Something went wrong. Please try again. status: description: >- Always the literal string `error` for failures. Some endpoints omit this field. type: string example: error error: description: Legacy single error code/string used by older endpoints. type: string example: invalid_request nullable: true code: description: >- Optional application-level error code (not all endpoints populate this). type: string example: DONOR_NOT_FOUND nullable: true type: object RequestRejection: description: >- Request or workflow rejection. Framework field-validation failures contain errors; semantic rejections may contain message without errors; legacy/provider failures may use error and error_code. The operation description identifies the rejected condition. Domain responses may add current revision, limits or other conflict context. anyOf: - $ref: '#/components/schemas/ValidationErrorResponse' - $ref: '#/components/schemas/ErrorResponse' - required: - error properties: error: description: Legacy or provider-facing error message. type: string example: The request could not be completed. error_code: description: Stable domain error code, when provided. type: string example: WORKFLOW_UNAVAILABLE type: object WorkspaceCatalogFileDoc: properties: id: type: string name: type: string source: type: string type: type: string mime: type: string nullable: true modified: type: string format: date-time nullable: true created: type: string format: date-time nullable: true status: type: string nullable: true document_id: type: string nullable: true context_label: type: string nullable: true context_url: type: string nullable: true collection_id: type: integer nullable: true size: type: integer nullable: true starred: type: boolean capabilities: properties: preview: type: boolean open_source: type: boolean star: type: boolean collect: type: boolean delete: type: boolean type: object match_snippet: description: Present for a content search match. type: string nullable: true type: object ValidationErrorResponse: title: ValidationErrorResponse description: >- Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The `errors` map is keyed by the failing field name; each value is an array of human-readable error messages for that field. Most controllers also include a top-level `status: error`. required: - errors properties: errors: description: >- Map of field name to array of validator error messages. Example: `{email: [The email field is required.], amount: [The amount must be a number.]}`. type: object additionalProperties: type: array items: type: string status: description: Always the literal string `error`. type: string example: error message: description: >- Optional summary message — present on some endpoints, absent on others. type: string example: The given data was invalid. nullable: true type: object securitySchemes: bearerAuth: type: http description: Passport bearer token authentication for legacy admin sessions. scheme: bearer bearerFormat: JWT apiKeyAuth: type: apiKey description: Gratona API key sent with the compatibility header X-HYS-API-Key. name: X-HYS-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.