Skip to main content
GET
/
v1
/
announcements
List announcements
curl --request GET \
  --url https://api.truthlocks.com/v1/announcements \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "subject": "<string>",
      "body": "<string>",
      "is_read": true,
      "created_at": "<string>"
    }
  ]
}
Returns all announcements sent to your tenant by the Truthlocks platform. Announcements include system updates, security alerts, and operational notifications. You can also view announcements in the console. See the console onboarding guide for details on the announcements inbox.

​
Responses

​
Announcement priority levels

PriorityDescription
NORMALGeneral platform updates and informational messages.
URGENTTime-sensitive changes that may affect your workflows.
CRITICALSecurity alerts or service disruptions requiring immediate attention.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Response

Announcements

​
items
object[]