Skip to main content

List tasks

GET 
/v2/tasks

Fetches multiple task records. The records can be filtered, paged, and sorted according to the respective parameters.

Request​

Query Parameters

    ids integer[]

    IDs of tasks to fetch.

    Example: [1234, 9876]
    user_id integer[]

    Filters tasks by the user to which they are assigned.

    Example: [1234, 9876]
    person_id integer[]

    Filters tasks by the person to which they are associated.

    Example: [1234, 9876]
    account_id integer[]

    Filters tasks by the account to which they are associated.

    Example: [1234, 9876]
    current_state string[]

    Filters tasks by their current state. Valid current_states include: ['scheduled', 'completed'].

    Example: [scheduled, completed]
    task_type string[]

    Filters tasks by their task type. Valid task_types include: ['call', 'email', 'general'].

    Example: [call, email]
    time_interval_filter string

    Filters tasks by time interval. Valid time_intervals include: ['overdue', 'today', 'tomorrow', 'this_week', 'next_week'].

    Example: overdue
    completed_time_interval string

    Filters tasks by time interval. Valid time_intervals include: ['today', 'yesterday', 'this_week', 'previous_week', 'this_month'].

    Example: today
    idempotency_key string

    Filters tasks by idempotency key.

    Example: source-123
    locale string[]

    Filters tasks by locale of the person to which they are associated.

    Example: [US/Eastern]
    source string[]

    Filters tasks by source.

    Example: [salesloft.api, salesloft.cadence, salesloft.signal]
    updated_at[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    completed_at[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    completed_at[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    completed_at[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    completed_at[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    include_counts_acted_on[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    include_counts_acted_on[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    include_counts_acted_on[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    include_counts_acted_on[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    sort_by string

    Key to sort on, must be one of: due_date, due_at, utc_offset, company, updated_at, completed_at, salesloft.prioritizers/rhythm. Defaults to due_date

    sort_direction string

    Direction to sort in, must be one of: ASC, DESC. Defaults to ASC

    per_page integer

    How many records to show per page in the range [1, 100]. Defaults to 25

    page integer

    The current page to fetch results from. Defaults to 1

    include_paging_counts boolean

    Whether to include total_pages and total_count in the metadata. Defaults to false

    limit_paging_counts boolean

    Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data

Responses​

Success

Schema
    id integer

    ID of Task

    created_at date-time

    Datetime of when the Task was created

    updated_at date-time

    Datetime of when the Task was last updated

    description string

    A description of the task recorded for person at completion time

    due_date date

    Date of when the Task is due, ISO-8601 date format required

    due_at date-time

    Datetime of when the Task is due, can be null. ISO-8601 datetime format required

    subject string

    Subject line of the task

    current_state string

    The state of the task. Valid states are: scheduled, completed

    person object

    The person to be contacted

    id integer
    _href string
    opportunity object

    The opportunity associated with task

    id integer
    _href string
    user object

    User who is assigned the task

    id integer
    _href string
    created_by_user object

    User who created the task

    id integer
    _href string
    task_type string

    The type of the task. Valid types are: call, email, general

    remind_at date-time

    Datetime of when the user will be reminded of the task, ISO-8601 datetime format required

    expires_after date-time

    Datetime of when the the task will expire, ISO-8601 datetime format required

    completed_at date-time

    Datetime of when the task was completed, ISO-8601 datetime format required

    completed_by object

    User who completed the task

    id integer
    _href string
Loading...