Events
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 Event 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 Event 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 events
Bad Request
Not Authorized
Not found
Unexpected error
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,
"progress": 50,
"production": true,
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"created": 1234567890,
"updated": 1234567890,
"start": 1234567890,
"end": 1234567890
}
}
]
}The unique ID of the Event. Ignored when creating new events.
The type of Event.
The deal ID this event is associated with
The address
A note about this event
Whether the event has been canceled
Percent complete of a production event, 0-100. Omitted when 0.
Whether this is a production event, which is what makes progress meaningful. Omitted when false.
Details about the new Event
The unique ID of the Event. Ignored when creating new events.
The type of Event.
The deal ID this event is associated with
The address
A note about this event
Whether the event has been canceled
Percent complete of a production event, 0-100. Omitted when 0.
Whether this is a production event, which is what makes progress meaningful. Omitted when false.
Bad Request
Not Authorized
Not found
Unexpected error
POST /v2/events HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 467
{
"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,
"progress": 50,
"production": true,
"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,
"progress": 50,
"production": true,
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"created": 1234567890,
"updated": 1234567890,
"start": 1234567890,
"end": 1234567890
}
}ID of the Event
Details about the event
The unique ID of the Event. Ignored when creating new events.
The type of Event.
The deal ID this event is associated with
The address
A note about this event
Whether the event has been canceled
Percent complete of a production event, 0-100. Omitted when 0.
Whether this is a production event, which is what makes progress meaningful. Omitted when false.
Bad Request
Not Authorized
Not found
Unexpected error
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,
"progress": 50,
"production": true,
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"created": 1234567890,
"updated": 1234567890,
"start": 1234567890,
"end": 1234567890
}
}ID of the Event
The unique ID of the Event. Ignored when creating new events.
The type of Event.
The deal ID this event is associated with
The address
A note about this event
Whether the event has been canceled
Percent complete of a production event, 0-100. Omitted when 0.
Whether this is a production event, which is what makes progress meaningful. Omitted when false.
The updated event
The unique ID of the Event. Ignored when creating new events.
The type of Event.
The deal ID this event is associated with
The address
A note about this event
Whether the event has been canceled
Percent complete of a production event, 0-100. Omitted when 0.
Whether this is a production event, which is what makes progress meaningful. Omitted when false.
Bad Request
Not Authorized
Not found
Unexpected error
PUT /v2/events/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 467
{
"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,
"progress": 50,
"production": true,
"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,
"progress": 50,
"production": true,
"owner": {
"id": "ownerid1234",
"firstName": "John",
"lastName": "Doe",
"email": "johndoefake@fakemail.com"
},
"timestamp": {
"created": 1234567890,
"updated": 1234567890,
"start": 1234567890,
"end": 1234567890
}
}ID of the Event
No Content
No content
Bad Request
Not Authorized
Not found
Unexpected error
DELETE /v2/events/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?