---
title: "List in-app campaigns for an agent"
method: GET
path: "/workspaces/{workspaceId}/agents/{agentId}/in-app"
tags: ["Agents"]
---

# List in-app campaigns for an agent

`GET /workspaces/{workspaceId}/agents/{agentId}/in-app`

## Request

- Base URL: `https://app.communicate.so/api/v1`
- URL: `https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/in-app`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Secure-better-auth.session_token`
  - API key in cookie `better-auth.session_token`

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.

## Path parameters

- `workspaceId` string, required
- `agentId` string, required

## Response `200`

List in-app campaigns for an agent

- ListInAppCampaignsResponse
  - `nudges` object[], required
    - `id` string, required
    - `workspaceId` string, required
    - `agentId` string, required
    - `name` string, required
    - `status` 'draft' | 'live' | 'paused' | 'archived', required
    - `surface` 'floating_card' | 'in_panel' | 'toast', required
    - `priority` integer, required
    - `content` object, required
    - `targeting` object, required
    - `frequency` 'once' | 'every_session' | 'always', required
    - `delaySeconds` integer, required
    - `scheduledAt` string, date-time, nullable, required
    - `expiresAt` string, date-time, nullable, required
    - `publishedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `401`: Missing, invalid, expired or revoked account credential or application session.
- `402`: Plan entitlement, capacity or credits do not allow this operation.
- `403`: Required account scope, live verified identity, membership or role permission is missing.
- `404`: Workspace or addressed resource is not visible to this member.
- `409`: Support handle, source URL or pending transfer conflicts with this operation.
- `422`: Website URL or extraction source is not supported.
- `429`: Agent request or website crawl rate limit exceeded.
- `500`: Unexpected server failure.
- `503`: Authorization service temporarily unavailable.

---

[API](https://skmtc.dev/communicate/apis/communicate-public-rest-api-2.md) · [All operations](https://skmtc.dev/communicate/apis/communicate-public-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/communicate/apis/communicate-public-rest-api-2/revisions/db6be3d36733?raw)