Skip to main content

Fetch a task

GET 

/v2/tasks/:id

Fetches a task, by ID only.

Request

Path Parameters

    id stringrequired

    Task ID

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...