Managani Docs

Appearance

List a page of opportunity summaries with current actions and inbox/actions/history counts ​

This Content Strategy operation is available through GET /product/sites/{siteId}/opportunities. Use the reference below to inspect its request contract and documented responses before connecting it to your application.

Request preparation ​

Send a GET request to /product/sites/{siteId}/opportunities on the appropriate server. Check the API overview for base URL guidance and the server information in the interactive reference. Replace path placeholders with identifiers from the intended account or site; a similarly named record in another workspace is not interchangeable.

The declared request parameters are:

  • siteId (path, required): Use the type and constraints shown in the parameter reference.
  • ids (query, optional): Optional comma-separated list of 1–200 opportunity IDs. Returns full enriched matching items and missing_ids; omits pagination and workspace counts. Without IDs, returns bounded card summaries; use the individual opportunity endpoint for full evidence and drafts.
  • workspace (query, optional): Use the type and constraints shown in the parameter reference.
  • type (query, optional): Filter by source or action type, such as reddit, bluesky, or blog. Counts reflect this filter across all workspaces.
  • page (query, optional): Use the type and constraints shown in the parameter reference.
  • limit (query, optional): Use the type and constraints shown in the parameter reference.
  • tasks (query, optional): Return independent outcome tasks with task-based pagination. inbox means needs attention; actions means in progress. Type accepts blog, page, or social.
  • topic (query, optional): Filter tasks by topic ID.

No request body is declared in the current specification. Check the route and any documented parameters before sending the request rather than adding an arbitrary JSON payload.

Authentication and scope ​

The specification lists these security alternatives: BearerAuth, AccessToken, AdminSession. Read any operation-specific restrictions as well: browser-session, account-role, and signed-user requirements may impose additional conditions. See authentication before choosing a credential.

Keep credentials in the appropriate private configuration and remove secrets from shared logs. Confirm the target resource belongs to the intended workflow before issuing a request. Authentication alone should not be treated as confirmation that a supplied account, site, or customer identifier is correct.

Response handling ​

The documented responses for List a page of opportunity summaries with current actions and inbox/actions/history counts are:

  • 200: Success
  • 400: Invalid input, unsupported action, unavailable integration, or action already running

Begin with a known record or a narrow query and inspect the returned fields before displaying them to users. Where the operation defines pagination, follow those parameters to retrieve additional results. An empty successful response is different from a failed request; keep errors visible to the calling workflow instead of presenting them as an empty data set.

If a connection fails after submission, investigate the current server state before repeating an action whose outcome is uncertain. When requesting support, retain the method, route, response status, and sanitized error message. The interactive reference below provides the detailed schemas and examples for this specific operation.

List a page of opportunity summaries with current actions and inbox/actions/history counts​

GET
/product/sites/{siteId}/opportunities

Authorizations​

BearerAuth

JWT token from login

Type
HTTP (bearer)
or
AccessToken

Personal access token. Value: Token <your-token>

Type
API Key (header: Authorization)
or
AdminSession

Authenticated backend-admin session cookie.

Type
API Key (cookie: connect.sid)

Parameters​

Path Parameters

siteId*
Type
string
Required

Query Parameters

ids

Optional comma-separated list of 1–200 opportunity IDs. Returns full enriched matching items and missing_ids; omits pagination and workspace counts. Without IDs, returns bounded card summaries; use the individual opportunity endpoint for full evidence and drafts.

Type
string
workspace
Type
string
Valid values
"inbox""actions""history"
type

Filter by source or action type, such as reddit, bluesky, or blog. Counts reflect this filter across all workspaces.

Type
string
Max Length
40
page
Type
integer
Minimum
1
Default
1
limit
Type
integer
Minimum
1
Maximum
100
Default
50
tasks

Return independent outcome tasks with task-based pagination. inbox means needs attention; actions means in progress. Type accepts blog, page, or social.

Type
boolean
Default
false
topic

Filter tasks by topic ID.

Type
string

Responses​

Success

application/json
JSON
{
  
"opportunities": [
  
  
{
  
  
  
"_id": "string",
  
  
  
"workspace": "string",
  
  
  
"actions": [
  
  
  
]
  
  
}
  
],
  
"counts": {
  
},
  
"total": 0,
  
"page": 0,
  
"pages": 0,
  
"limit": 0,
  
"missing_ids": [
  
  
"string"
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI