Events

List Events

get

Authorizations

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 events

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/events

GET /v2/events HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalRows": 1,
  "page": 1,
  "perPage": 1,
  "rows": [
    {
      "id": "f123453-abcd-1234-abcd-122233324989",
      "eventType": "follow-up",
      "dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
      "address": "123 Main St, Springfield, IL 62701",
      "note": "Follow up with the client to discuss project details.",
      "canceled": false,
      "owner": {
        "id": "ownerid1234",
        "firstName": "John",
        "lastName": "Doe",
        "email": "johndoefake@fakemail.com"
      },
      "timestamp": {
        "created": 1234567890,
        "updated": 1234567890,
        "start": 1234567890,
        "end": 1234567890
      }
    }
  ]
}

Create Event

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idstringOptional

The unique ID of the Event. Ignored when creating new events.

eventTypestringOptional

The type of Event.

dealIdstringOptional

The deal ID this event is associated with

addressstring · nullableOptional

The address

notestring · nullableOptional

A note about this event

canceledboolean · nullableOptional

Whether the event has been canceled

Responses

200

Details about the new Event

application/json

idstringOptional

The unique ID of the Event. Ignored when creating new events.

eventTypestringOptional

The type of Event.

dealIdstringOptional

The deal ID this event is associated with

addressstring · nullableOptional

The address

notestring · nullableOptional

A note about this event

canceledboolean · nullableOptional

Whether the event has been canceled

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/events

POST /v2/events HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 435

{
  "id": "f123453-abcd-1234-abcd-122233324989",
  "eventType": "follow-up",
  "dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "address": "123 Main St, Springfield, IL 62701",
  "note": "Follow up with the client to discuss project details.",
  "canceled": false,
  "owner": {
    "id": "ownerid1234",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoefake@fakemail.com"
  },
  "timestamp": {
    "created": 1234567890,
    "updated": 1234567890,
    "start": 1234567890,
    "end": 1234567890
  }
}

{
  "id": "f123453-abcd-1234-abcd-122233324989",
  "eventType": "follow-up",
  "dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "address": "123 Main St, Springfield, IL 62701",
  "note": "Follow up with the client to discuss project details.",
  "canceled": false,
  "owner": {
    "id": "ownerid1234",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoefake@fakemail.com"
  },
  "timestamp": {
    "created": 1234567890,
    "updated": 1234567890,
    "start": 1234567890,
    "end": 1234567890
  }
}

Retrieve Event

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Event

Responses

200

Details about the event

application/json

idstringOptional

The unique ID of the Event. Ignored when creating new events.

eventTypestringOptional

The type of Event.

dealIdstringOptional

The deal ID this event is associated with

addressstring · nullableOptional

The address

notestring · nullableOptional

A note about this event

canceledboolean · nullableOptional

Whether the event has been canceled

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/events/{id}

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

{
  "id": "f123453-abcd-1234-abcd-122233324989",
  "eventType": "follow-up",
  "dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "address": "123 Main St, Springfield, IL 62701",
  "note": "Follow up with the client to discuss project details.",
  "canceled": false,
  "owner": {
    "id": "ownerid1234",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoefake@fakemail.com"
  },
  "timestamp": {
    "created": 1234567890,
    "updated": 1234567890,
    "start": 1234567890,
    "end": 1234567890
  }
}

Update Event

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Event

Body

idstringOptional

The unique ID of the Event. Ignored when creating new events.

eventTypestringOptional

The type of Event.

dealIdstringOptional

The deal ID this event is associated with

addressstring · nullableOptional

The address

notestring · nullableOptional

A note about this event

canceledboolean · nullableOptional

Whether the event has been canceled

Responses

200

The updated event

application/json

idstringOptional

The unique ID of the Event. Ignored when creating new events.

eventTypestringOptional

The type of Event.

dealIdstringOptional

The deal ID this event is associated with

addressstring · nullableOptional

The address

notestring · nullableOptional

A note about this event

canceledboolean · nullableOptional

Whether the event has been canceled

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/events/{id}

PUT /v2/events/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 435

{
  "id": "f123453-abcd-1234-abcd-122233324989",
  "eventType": "follow-up",
  "dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "address": "123 Main St, Springfield, IL 62701",
  "note": "Follow up with the client to discuss project details.",
  "canceled": false,
  "owner": {
    "id": "ownerid1234",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoefake@fakemail.com"
  },
  "timestamp": {
    "created": 1234567890,
    "updated": 1234567890,
    "start": 1234567890,
    "end": 1234567890
  }
}

{
  "id": "f123453-abcd-1234-abcd-122233324989",
  "eventType": "follow-up",
  "dealId": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "address": "123 Main St, Springfield, IL 62701",
  "note": "Follow up with the client to discuss project details.",
  "canceled": false,
  "owner": {
    "id": "ownerid1234",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoefake@fakemail.com"
  },
  "timestamp": {
    "created": 1234567890,
    "updated": 1234567890,
    "start": 1234567890,
    "end": 1234567890
  }
}

Delete Event

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Event

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/events/{id}

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

No content

Last updated 18 days ago

Was this helpful?