Tasks & Projects

Get all tasks

get

Returns a paginated list of tasks for the organization.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Query parameters

cursorstringOptional

The cursor to use for pagination.

limitinteger · int64Optional

The number of tasks to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

get

/tasks

HTTPcURLJavaScriptPython

GET /tasks HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "account": {
        "id": "text"
      },
      "assignee": {
        "contact": {
          "email": "text",
          "id": "text"
        },
        "user": {
          "email": "text",
          "id": "text"
        }
      },
      "body_html": "text",
      "created_at": "text",
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "slug": "text",
          "value": "text",
          "values": [
            "text"
          ]
        }
      },
      "customer_portal_visible": true,
      "due_date": "text",
      "id": "text",
      "milestone": {
        "id": "text"
      },
      "parent_task_id": "text",
      "project": {
        "id": "text"
      },
      "status": "not_started",
      "subtask_ids": [
        "text"
      ],
      "title": "text",
      "updated_at": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Get a task by its ID

get

Returns a single task by ID.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the task to fetch.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

get

/tasks/{id}

HTTPcURLJavaScriptPython

GET /tasks/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "contact": {
        "email": "text",
        "id": "text"
      },
      "user": {
        "email": "text",
        "id": "text"
      }
    },
    "body_html": "text",
    "created_at": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "customer_portal_visible": true,
    "due_date": "text",
    "id": "text",
    "milestone": {
      "id": "text"
    },
    "parent_task_id": "text",
    "project": {
      "id": "text"
    },
    "status": "not_started",
    "subtask_ids": [
      "text"
    ],
    "title": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

Search for tasks by a given filter

post

Currently, the following fields are filterable for tasks:

• account_id. Allowed operators: equals, in, not_in, is_set

• project_id. Allowed operators: equals, in, not_in, is_set, is_unset

• status. Valid values are ["not_started", "in_progress", "completed"]. Allowed operators: equals, in, not_in

• assignee_id. Allowed operators: equals, in, not_in, is_set

• milestone_id. Allowed operators: equals, in, not_in, is_set

• created_at (in RFC3339 format). Allowed operators: time_is_after, time_is_before, time_range

• due_date (in RFC3339 format). Allowed operators: time_is_after, time_is_before, time_range, is_set

• updated_at (in RFC3339 format). Allowed operators: time_is_after, time_is_before, time_range

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

cursorstringOptional

The cursor to use for pagination.

limitinteger · int64Optional

The number of tasks to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

200Success

application/json

request_idstringOptional

400Error

application/json

post

/tasks/search

HTTPcURLJavaScriptPython

POST /tasks/search HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 312

{
  "cursor": "text",
  "filter": {
    "field": "text",
    "operator": "equals",
    "subfilters": [
      {
        "field": "text",
        "operator": "equals",
        "subfilters": [
          {
            "field": "text",
            "operator": "equals",
            "subfilters": "[Circular Reference]",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "value": "text",
    "values": [
      "text"
    ]
  },
  "limit": 1
}

{
  "data": [
    {
      "account": {
        "id": "text"
      },
      "assignee": {
        "contact": {
          "email": "text",
          "id": "text"
        },
        "user": {
          "email": "text",
          "id": "text"
        }
      },
      "body_html": "text",
      "created_at": "text",
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "slug": "text",
          "value": "text",
          "values": [
            "text"
          ]
        }
      },
      "customer_portal_visible": true,
      "due_date": "text",
      "id": "text",
      "milestone": {
        "id": "text"
      },
      "parent_task_id": "text",
      "project": {
        "id": "text"
      },
      "status": "not_started",
      "subtask_ids": [
        "text"
      ],
      "title": "text",
      "updated_at": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Create a task

post

Creates a new task with a title and optional metadata.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

account_idstringOptional

Account ID for this task

assignee_idstringOptional

Assignee ID for this task

body_htmlstringOptional

Body HTML for this task

customer_portal_visiblebooleanOptional

Customer portal visible for this task

Default: false

due_datestringOptional

Due date for this task, in RFC 3339 format

milestone_idstringOptional

Milestone ID for this task

project_idstringOptional

Project ID for this task

statusstring · enumOptional

Status for this task

• not_started TaskStatusNotStarted

• in_progress TaskStatusInProgress

• completed TaskStatusCompleted

Possible values:

titlestringRequired

Title for this task

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

post

/tasks

HTTPcURLJavaScriptPython

POST /tasks HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "account_id": "text",
  "assignee_id": "text",
  "body_html": "text",
  "custom_fields": [
    {
      "slug": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "customer_portal_visible": false,
  "due_date": "text",
  "milestone_id": "text",
  "project_id": "text",
  "status": "not_started",
  "title": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "contact": {
        "email": "text",
        "id": "text"
      },
      "user": {
        "email": "text",
        "id": "text"
      }
    },
    "body_html": "text",
    "created_at": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "customer_portal_visible": true,
    "due_date": "text",
    "id": "text",
    "milestone": {
      "id": "text"
    },
    "parent_task_id": "text",
    "project": {
      "id": "text"
    },
    "status": "not_started",
    "subtask_ids": [
      "text"
    ],
    "title": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

Update a task

patch

Updates an existing task. Only provided fields are modified.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the task to update.

Body

application/json

assignee_idstringOptional

Assignee ID for this task

body_htmlstringOptional

Body HTML for this task

customer_portal_visiblebooleanOptional

Customer portal visible for this task

due_datestringOptional

Due date for this task, in RFC 3339 format

milestone_idstringOptional

Milestone ID for this task

project_idstringOptional

Project ID for this task

statusstring · enumOptional

Status for this task

• not_started TaskStatusNotStarted

• in_progress TaskStatusInProgress

• completed TaskStatusCompleted

Possible values:

titlestringOptional

Title for this task

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

patch

/tasks/{id}

HTTPcURLJavaScriptPython

PATCH /tasks/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "assignee_id": "text",
  "body_html": "text",
  "custom_fields": [
    {
      "slug": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "customer_portal_visible": true,
  "due_date": "text",
  "milestone_id": "text",
  "project_id": "text",
  "status": "not_started",
  "title": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "contact": {
        "email": "text",
        "id": "text"
      },
      "user": {
        "email": "text",
        "id": "text"
      }
    },
    "body_html": "text",
    "created_at": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "customer_portal_visible": true,
    "due_date": "text",
    "id": "text",
    "milestone": {
      "id": "text"
    },
    "parent_task_id": "text",
    "project": {
      "id": "text"
    },
    "status": "not_started",
    "subtask_ids": [
      "text"
    ],
    "title": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

Delete an existing task

delete

Permanently deletes a task by ID.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the task to delete.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

delete

/tasks/{id}

HTTPcURLJavaScriptPython

DELETE /tasks/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "request_id": "text"
}

Update a project

patch

Updates an existing project. Only provided fields are modified.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the project to update.

Body

application/json

customer_portal_visiblebooleanOptional

Customer portal visible for this project

description_htmlstringOptional

Description HTML for this project

end_datestringOptional

End date for this project, in RFC 3339 format

is_archivedbooleanOptional

Whether the project is archived

namestringOptional

Name for this project

owner_idstringOptional

Owner ID for this project

start_datestringOptional

Start date for this project, in RFC 3339 format

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

patch

/projects/{id}

HTTPcURLJavaScriptPython

PATCH /projects/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "customer_portal_visible": true,
  "description_html": "text",
  "end_date": "text",
  "is_archived": true,
  "name": "text",
  "owner_id": "text",
  "start_date": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "archived_at": "text",
    "created_at": "text",
    "customer_portal_visible": true,
    "description_html": "text",
    "end_date": "text",
    "id": "text",
    "is_archived": true,
    "name": "text",
    "owner_id": "text",
    "project_template": {
      "id": "text"
    },
    "start_date": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

Delete an existing project

delete

Permanently deletes a project by ID.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the project to delete.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

delete

/projects/{id}

HTTPcURLJavaScriptPython

DELETE /projects/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "request_id": "text"
}

Create a project

post

Creates a new project for an account.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

account_idstringRequired

Account ID for this project

customer_portal_visiblebooleanOptional

Customer portal visible for this project

Default: false

description_htmlstringOptional

Description HTML for this project

end_datestringOptional

End date for this project, in RFC 3339 format

namestringRequired

Name for this project

owner_idstringOptional

Owner ID for this project

project_template_idstringOptional

Project template ID for this project

start_datestringOptional

Start date for this project, in RFC 3339 format

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

post

/projects

HTTPcURLJavaScriptPython

POST /projects HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "account_id": "text",
  "customer_portal_visible": false,
  "description_html": "text",
  "end_date": "text",
  "name": "text",
  "owner_id": "text",
  "project_template_id": "text",
  "start_date": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "archived_at": "text",
    "created_at": "text",
    "customer_portal_visible": true,
    "description_html": "text",
    "end_date": "text",
    "id": "text",
    "is_archived": true,
    "name": "text",
    "owner_id": "text",
    "project_template": {
      "id": "text"
    },
    "start_date": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

Update a milestone

patch

Updates an existing milestone. Only provided fields are modified.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the milestone to update.

Body

application/json

due_datestringOptional

Due date for this milestone, in RFC 3339 format

namestringOptional

Name for this milestone

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

patch

/milestones/{id}

HTTPcURLJavaScriptPython

PATCH /milestones/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "due_date": "text",
  "name": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "created_at": "text",
    "due_date": "text",
    "id": "text",
    "name": "text",
    "project": {
      "id": "text"
    },
    "updated_at": "text"
  },
  "request_id": "text"
}

Create a milestone

post

Creates a new milestone within a project.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

account_idstringOptional

Account ID for this project

due_datestringOptional

Due date for this milestone, in RFC 3339 format

namestringRequired

Name for this milestone

project_idstringRequired

Project ID for this milestone

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

post

/milestones

HTTPcURLJavaScriptPython

POST /milestones HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "account_id": "text",
  "due_date": "text",
  "name": "text",
  "project_id": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "created_at": "text",
    "due_date": "text",
    "id": "text",
    "name": "text",
    "project": {
      "id": "text"
    },
    "updated_at": "text"
  },
  "request_id": "text"
}

Delete a milestone

delete

Permanently deletes a milestone by ID.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the milestone to delete.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

delete

/milestones/{id}

HTTPcURLJavaScriptPython

DELETE /milestones/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "request_id": "text"
}