Tasks
Page number to fetch, 1-indexed. Defaults to 1.
Number of results per page (1-100). Defaults to the API's standard page size if omitted.
Lucene-style filter query (e.g. status:active AND createdAt:[2024-01-01 TO *]). Field names match the Task object's own fields. This syntax is part of an in-flight migration (see docs/design/lucene-migration-json-filter-spec.md) and may change.
Field name to sort by - any top-level field of the Task object returned by this endpoint. Defaults to the API's natural order if omitted.
Sort direction: asc or desc. Only takes effect when sort is set.
List of tasks
Bad Request
Not Authorized
Not found
Unexpected error
GET /v2/tasks HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"totalRows": 1,
"page": 1,
"perPage": 1,
"rows": [
{
"title": "Make the call",
"dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
"notes": "Call the client to see how everything is going.",
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"start": 1672531200
}
}
]
}The ID of the Task. Ignored when creating & updating tasks.
The title of the Task.
The deal ID this task is associated with
A note about this task
Whether the task has been completed
Details about the new Task
The ID of the Task. Ignored when creating & updating tasks.
The title of the Task.
The deal ID this task is associated with
A note about this task
Whether the task has been completed
Bad Request
Not Authorized
Not found
Unexpected error
POST /v2/tasks HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 264
{
"title": "Make the call",
"dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
"notes": "Call the client to see how everything is going.",
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"start": 1672531200
}
}{
"title": "Make the call",
"dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
"notes": "Call the client to see how everything is going.",
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"start": 1672531200
}
}ID of the Task
Details about the task
The ID of the Task. Ignored when creating & updating tasks.
The title of the Task.
The deal ID this task is associated with
A note about this task
Whether the task has been completed
Bad Request
Not Authorized
Not found
Unexpected error
GET /v2/tasks/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"title": "Make the call",
"dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
"notes": "Call the client to see how everything is going.",
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"start": 1672531200
}
}ID of the Task
The title of the Task.
The deal ID this task is associated with
A note about this task
Whether the task has been completed
The updated task
The ID of the Task. Ignored when creating & updating tasks.
The title of the Task.
The deal ID this task is associated with
A note about this task
Whether the task has been completed
Bad Request
Not Authorized
Not found
Unexpected error
PUT /v2/tasks/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 264
{
"title": "Make the call",
"dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
"notes": "Call the client to see how everything is going.",
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"start": 1672531200
}
}{
"title": "Make the call",
"dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
"notes": "Call the client to see how everything is going.",
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"start": 1672531200
}
}ID of the Task
No Content
No content
Bad Request
Not Authorized
Not found
Unexpected error
DELETE /v2/tasks/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?