Interface GetTasksRequest

interface GetTasksRequest {
    after?: string;
    limit?: number;
    name?: string;
    org?: string;
    orgID?: string;
    status?: string;
    type?: string;
    user?: string;
}

Properties

after? limit? name? org? orgID? status? type? user?

Properties

Optionalafter

after?: string

A task ID. Only returns tasks created after the specified task.

Optionallimit

limit?: number

The maximum number of tasks to return. Default is 100. The minimum is 1 and the maximum is 500.

To reduce the payload size, combine type=basic and limit (see Request samples). For more information about the basic response, see the type parameter.

Optionalname

name?: string

A task name. Only returns tasks with the specified name. Different tasks may have the same name.

Optionalorg

org?: string

An organization name. Only returns tasks owned by the specified organization.

OptionalorgID

orgID?: string

An organization ID. Only returns tasks owned by the specified organization.

Optionalstatus

status?: string

A task status. Only returns tasks that have the specified status (active or inactive).

Optionaltype

type?: string

A task type (basic or system). Default is system. Specifies the level of detail for tasks in the response. The default (system) response contains all the metadata properties for tasks. To reduce the response size, pass basic to omit some task properties (flux, createdAt, updatedAt).

Optionaluser

user?: string

A user ID. Only returns tasks owned by the specified user.

Settings

Member Visibility

On This Page

Properties