@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?: IdList;
        limit?: number;
        offset?: number;
        portal?: Id;
        publicbody?: Id;
        tag?: string;
    }

    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?: IdList

    Document ids: "26,27" or [26, 27]. Every element must be an integer — upstream, one bad element ("26,abc", "26;27") drops the whole filter.

    limit?: number

    Page size: an integer from 1 to MAX_PAGE_SIZE (50); defaults server-side to 50.

    offset?: number

    Position in the whole result set: a non-negative integer.

    portal?: Id
    publicbody?: Id
    tag?: string

    A tag slug (the API matches the tag's slug; an unknown one matches nothing).

    Settings
    Member Visibility

    On This Page
    Properties