Activities

List Activities

get

Returns the activity feed for a document (deal, contact, company, quote, or invoice) — the same feed shown in the app's activity/history panel. Notes and internal/admin-only activity types are excluded; see the activityType parameter to narrow to a specific kind of event, such as tags-changed.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · int32 · min: 1Optional

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

docIdstringOptional

Filter to activities attached to this document ID (deal, contact, company, quote, or invoice)

docTypestringOptional

Filter to activities attached to this document type. Note: quotes and invoices share the internal document type quote — filter by docId for invoice-specific results, or by docType=quote to get both.

activityTypestringOptional

Filter to a specific activity type, e.g. "tags-changed"

sortstring · enumOptional

Field to sort by

Default: timestampPossible values:

sortDirstring · enumOptional

Sort direction: asc or desc. Only takes effect when sort is set.

Possible values:

Responses

200

List of activities

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

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

{
  "totalRows": 1,
  "page": 1,
  "perPage": 1,
  "rows": [
    {
      "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
      "docIds": [
        "deal_abc123"
      ],
      "docType": "deal",
      "activityType": "tags-changed",
      "events": [
        "Hot Lead"
      ],
      "owner": {
        "id": "user_abc123",
        "firstName": "Alice",
        "lastName": "Smith"
      },
      "timestamp": 1672531200000
    }
  ]
}