Tasks

List Tasks

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · int32 · min: 1Optional

perPageinteger · int32 · min: 1 · max: 100Optional

querystringOptional

sortstringOptional

sortDirstring · enumOptionalPossible values:

Responses

200

List of tasks

application/json

totalRowsnumberOptional

pagenumberOptional

perPagenumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/tasks

HTTPcURLJavaScriptPython

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": "[e-mail]"
      },
      "timestamp": {
        "start": 1672531200
      }
    }
  ]
}

Create Task

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstringOptional

The ID of the Task. Ignored when creating & updating tasks.

titlestringOptional

The title of the Task.

dealIdstringOptional

The deal ID this task is associated with

notesstring · nullableOptional

A note about this task

completedboolean · nullableOptional

Whether the task has been completed

Responses

200

Details about the new Task

application/json

idstringOptional

The ID of the Task. Ignored when creating & updating tasks.

titlestringOptional

The title of the Task.

dealIdstringOptional

The deal ID this task is associated with

notesstring · nullableOptional

A note about this task

completedboolean · nullableOptional

Whether the task has been completed

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/tasks

HTTPcURLJavaScriptPython

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": "[e-mail]"
  },
  "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": "[e-mail]"
  },
  "timestamp": {
    "start": 1672531200
  }
}

Retrieve Task

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Task

Responses

200

Details about the task

application/json

idstringOptional

The ID of the Task. Ignored when creating & updating tasks.

titlestringOptional

The title of the Task.

dealIdstringOptional

The deal ID this task is associated with

notesstring · nullableOptional

A note about this task

completedboolean · nullableOptional

Whether the task has been completed

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/tasks/{id}

HTTPcURLJavaScriptPython

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": "[e-mail]"
  },
  "timestamp": {
    "start": 1672531200
  }
}

Update Task

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Task

Body

application/json

titlestringOptional

The title of the Task.

dealIdstringRequired

The deal ID this task is associated with

notesstring · nullableOptional

A note about this task

completedboolean · nullableOptional

Whether the task has been completed

Responses

200

The updated task

application/json

idstringOptional

The ID of the Task. Ignored when creating & updating tasks.

titlestringOptional

The title of the Task.

dealIdstringOptional

The deal ID this task is associated with

notesstring · nullableOptional

A note about this task

completedboolean · nullableOptional

Whether the task has been completed

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/tasks/{id}

HTTPcURLJavaScriptPython

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": "[e-mail]"
  },
  "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": "[e-mail]"
  },
  "timestamp": {
    "start": 1672531200
  }
}

Delete Task

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Task

Responses

204

No Content

No content

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

delete/tasks/{id}

HTTPcURLJavaScriptPython

DELETE /v2/tasks/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content