Skip to main content
GET
/
api
/
prompts
/
{promptId}
/
usage
Check prompt usage by contacts and conversations
curl --request GET \
  --url https://your-instance.example.com/api/prompts/{promptId}/usage \
  --header 'Authorization: Bearer <token>'
{
  "promptId": "5f7b1c2e8a1d4e0012c3b4a5",
  "promptName": "Leasing follow-up assistant",
  "isInUse": true,
  "contactsCount": 24,
  "conversationsCount": 31,
  "totalUsageCount": 55,
  "hasAlternatives": true,
  "alternatives": [
    {
      "id": "5f7b1c2e8a1d4e0012c3b4a6",
      "name": "Standard follow-up assistant",
      "description": "Generic follow-up prompt."
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
promptId
string
required

Response

Prompt usage information returned

​
promptId
string
required
​
isInUse
boolean
required
​
contactsCount
integer
required
​
conversationsCount
integer
required
​
totalUsageCount
integer
required
​
promptName
string
​
hasAlternatives
boolean
​
alternatives
object[]