# Opal Activities API

**Canonical:** https://apis.io/apis/opal/opal-activities-api/  
**Provider:** Opal — https://apis.io/providers/opal/  
**Base URL:** https://login.ouropal.com  
**Documentation:** https://login.ouropal.com/api/documentation/v2

Opal Activities API is one of 79 APIs that [Opal](https://apis.io/providers/opal/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Activities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

## Activities Overview In Opal, "activities" encompass both things like someone adding an asset to content and also someone sending a chat message. In the user interface, these are called "Chat & Activity" but the underlying resource is always an `activity` record. This API currently supports _retrieving_ all types of activity (see the `activity_types` endpoint to retrieve a list of supported types). It only supports _creating_ chat activity. ## Checkpoints The `checkpoints` endpoints are how activities get marked as read for users. The idea is that any activity older than the most recent checkpoint has been seen by the user. ## User @mentions User mentions are represented in the plaintext body of activity messages. You can create them (or interpret them) using the following syntax: ``` @[{{user name}}](user:{{user_id}}) ``` The double-bracketed `{{user name}}` should be replaced with the user's full name (not their "username" or email) and `{{user_id}}` should be replaced with the user's _integer_ id value (not a UUID). Do not use quotation marks or spaces (except between the parts of a user's name). For example, `[John Doe](user:1234)`.

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-activities-api-openapi.yml
- **Documentation** — https://login.ouropal.com/api/documentation/v2
- **APIReference** — https://login.ouropal.com/api/documentation/v2
- **Documentation** — https://login.ouropal.com/api/documentation/v3
- **APIReference** — https://login.ouropal.com/api/documentation/v3
- **Documentation** — https://login.ouropal.com/api/documentation/asgard_bff

## Other Opal APIs (12)

- [Opal Accounts API](https://apis.io/apis/opal/opal-accounts-api/)
- [Opal Annotations API](https://apis.io/apis/opal/opal-annotations-api/)
- [Opal Asset Reference Options API](https://apis.io/apis/opal/opal-asset-reference-options-api/)
- [Opal Asset Reference Usage Rights Options API](https://apis.io/apis/opal/opal-asset-reference-usage-rights-options-api/)
- [Opal Asset References API](https://apis.io/apis/opal/opal-asset-references-api/)
- [Opal Assets API](https://apis.io/apis/opal/opal-assets-api/)
- [Opal Block Connectors API](https://apis.io/apis/opal/opal-block-connectors-api/)
- [Opal Block Custom Field Values API](https://apis.io/apis/opal/opal-block-custom-field-values-api/)
- [Opal Block Duplication API](https://apis.io/apis/opal/opal-block-duplication-api/)
- [Opal Blocks API](https://apis.io/apis/opal/opal-blocks-api/)
- [Opal Board Collaborators API](https://apis.io/apis/opal/opal-board-collaborators-api/)
- [Opal Board Columns API](https://apis.io/apis/opal/opal-board-columns-api/)

## Tags

Activities

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/opal/opal-activities-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/opal/.