Circle V2 API Docs
    Preparing search index...

    Type Alias TemplatesListInScopeParams

    type TemplatesListInScopeParams = {
        deletedOnly?: boolean;
        entityId: EntityId;
        includeDeleted?: boolean;
        limit?: number;
        offset?: number;
        search?: string;
        sortBy?: ListSortBy;
        sortOrder?: "asc" | "desc";
        userId: UserId;
    }
    Index

    Properties

    deletedOnly? entityId includeDeleted? limit? offset? search? sortBy? sortOrder? userId

    Properties

    deletedOnly?: boolean

    Return ONLY soft-deleted templates (the archived-templates view). Wins over includeDeleted.

    entityId: EntityId

    ID of organization that the templates are scoped to

    includeDeleted?: boolean

    Include soft-deleted templates (only for filters over historical runs)

    limit?: number
    offset?: number
    search?: string
    sortBy?: ListSortBy
    sortOrder?: "asc" | "desc"
    userId: UserId

    ID of user who is listing the templates

    Settings

    Member Visibility

    On This Page

    Properties