Interface CollectionsApiListCollectionsRequest

interface CollectionsApiListCollectionsRequest {
    pageSize?: number;
    cursor?: string;
    orderBy?:
        | "updated_at"
        | "name"
        | "address"
        | "project_id"
        | "created_at";
    direction?: string;
    blacklist?: string;
    whitelist?: string;
    keyword?: string;
}

Hierarchy

  • CollectionsApiListCollectionsRequest
    • CollectionsApiListCollectionsRequest

Properties

pageSize? cursor? orderBy? direction? blacklist? whitelist? keyword?

Properties

Optional ReadonlypageSize

pageSize?: number

Page size of the result

Memberof

CollectionsApiListCollections

Optional Readonlycursor

cursor?: string

Cursor

Memberof

CollectionsApiListCollections

Optional ReadonlyorderBy

orderBy?:
    | "updated_at"
    | "name"
    | "address"
    | "project_id"
    | "created_at"

Property to sort by

Memberof

CollectionsApiListCollections

Optional Readonlydirection

direction?: string

Direction to sort (asc/desc)

Memberof

CollectionsApiListCollections

Optional Readonlyblacklist

blacklist?: string

List of collections not to be included, separated by commas

Memberof

CollectionsApiListCollections

Optional Readonlywhitelist

whitelist?: string

List of collections to be included, separated by commas

Memberof

CollectionsApiListCollections

Optional Readonlykeyword

keyword?: string

Keyword to search in collection name and description

Memberof

CollectionsApiListCollections

Settings

Member Visibility

On This Page

Properties