> For the complete documentation index, see [llms.txt](https://help.paintscout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.paintscout.com/developers/activities.md).

# Activities

## List Activities

> 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\`.<br>

```json
{"openapi":"3.0.0","info":{"title":"Core API","version":"v2"},"servers":[{"url":"https://openapi.paintscout.com/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Activity":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The unique ID of the Activity"},"docIds":{"type":"array","items":{"type":"string"},"description":"IDs of the documents this activity is attached to (deal, contact, company, quote, or invoice)"},"docType":{"type":"string","description":"The type of document this activity is attached to"},"activityType":{"type":"string","description":"The kind of event this activity represents, e.g. \"tags-changed\""},"events":{"type":"array","nullable":true,"items":{"type":"string"},"description":"Human-readable details of the event, e.g. the tag labels that were added"},"owner":{"type":"object","nullable":true,"$ref":"#/components/schemas/Owner"},"timestamp":{"type":"number","nullable":true,"description":"When the event occurred, as a unix ms timestamp"}}},"Owner":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The unique user ID"},"firstName":{"type":"string","description":"The first name of the user"},"lastName":{"type":"string","description":"The last name of the user"},"title":{"type":"string","description":"The job title of the user"},"email":{"type":"string","description":"The email address of the user"},"phoneNumber":{"type":"string","nullable":true,"description":"The phone number of the user"},"phoneExtension":{"type":"string","nullable":true,"description":"The phone extension of the user"}}},"Error":{"type":"object","additionalProperties":false,"properties":{"errors":{"type":"array","items":{"type":"string"},"description":"Array of error messages"}}}}},"paths":{"/activities":{"get":{"summary":"List Activities","operationId":"listActivities","tags":["Activities"],"description":"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`.\n","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","minimum":1}},{"name":"perPage","in":"query","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100}},{"name":"docId","in":"query","schema":{"type":"string"},"description":"Filter to activities attached to this document ID (deal, contact, company, quote, or invoice)"},{"name":"docType","in":"query","schema":{"type":"string"},"description":"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.\n"},{"name":"activityType","in":"query","schema":{"type":"string"},"description":"Filter to a specific activity type, e.g. \"tags-changed\""},{"name":"sort","in":"query","schema":{"type":"string","enum":["timestamp"],"default":"timestamp"},"description":"Field to sort by"},{"name":"sortDir","in":"query","description":"Sort direction: `asc` or `desc`. Only takes effect when `sort` is set.","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"List of activities","content":{"application/json":{"schema":{"type":"object","properties":{"totalRows":{"type":"number"},"page":{"type":"number"},"perPage":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.paintscout.com/developers/activities.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
