Sales Engine
API documentation
FrameworksOperation frameworks.list

Frameworks list

Every framework with its numbers (leads, in campaign, sent, opened, replied, positive), expected reply rate and routing share.

GET/api/v1/frameworks
Scope read: Read anything in the workspace.

Parameters

Query

NameInDescription
categoryqueryopener, follow_up, closing or sequence. One of opener, follow_up, closing, sequence.
statusqueryactive or paused. One of active, paused.
searchqueryMatch on number, name or type.

Example

curl
curl -X GET "https://crm.ashwanth.dev/api/v1/frameworks" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"
CLI
sales-engine frameworks list

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Query
opener, follow_up, closing or sequence.
active or paused.
Match on number, name or type.
Request
GET /api/v1/frameworks

Also in Frameworks