List in-app campaigns for an agent
curl --request GET \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/in-app \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/in-app', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/in-app"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"nudges": [
{
"id": "<string>",
"workspaceId": "<string>",
"agentId": "<string>",
"name": "<string>",
"status": "draft",
"surface": "floating_card",
"priority": 0,
"content": {},
"targeting": {},
"frequency": "once",
"delaySeconds": 0,
"scheduledAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Agents
List in-app campaigns for an agent
Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.
GET
/
workspaces
/
{workspaceId}
/
agents
/
{agentId}
/
in-app
List in-app campaigns for an agent
curl --request GET \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/in-app \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/in-app', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/in-app"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"nudges": [
{
"id": "<string>",
"workspaceId": "<string>",
"agentId": "<string>",
"name": "<string>",
"status": "draft",
"surface": "floating_card",
"priority": 0,
"content": {},
"targeting": {},
"frequency": "once",
"delaySeconds": 0,
"scheduledAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Authorizations
accountBeareraccountSessionlocalAccountSession
Opaque user-bound ca_ account credential. Each request checks live account scopes, verified email, expiry, revocation and the issuer session. Not a workspace ck_ key or OAuth access token.
Path Parameters
Minimum string length:
1Minimum string length:
1Response
List in-app campaigns for an agent
Show child attributes
Show child attributes