@maschinenlesbar.org/fragdenstaat-cli
    Preparing search index...

    Interface DocumentListParams

    Filters for GET /api/v1/document/ (published documents).

    interface DocumentListParams {
        collection?: Id;
        created_at_after?: string;
        created_at_before?: string;
        directory?: Id;
        foirequest?: Id;
        ids?: string;
        limit?: number;
        offset?: number;
        portal?: Id;
        publicbody?: Id;
        tag?: Id;
    }

    Hierarchy (View Summary)

    Index
    collection? created_at_after? created_at_before? directory? foirequest? ids? limit? offset? portal? publicbody? tag?
    collection?: Id
    created_at_after?: string
    created_at_before?: string
    directory?: Id
    foirequest?: Id
    ids?: string

    Comma-separated list of document ids.

    limit?: number

    Page size. The server caps this (see DEVELOPING.md); defaults server-side.

    offset?: number
    portal?: Id
    publicbody?: Id
    tag?: Id

    A tag id (numeric); the API rejects free-text tag names here.

    Settings
    Member Visibility

    On This Page
    Properties