context

List context entries

Changed on

List saved context entries (user profile, what they sell, Messaging Playbook). Filter by type and scope; results are paged. Entries come back as a 200-char preview; pass fullContent=true to read one entry in full, which is how to read a specific saved context such as a playbook.

get/context

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/context
  • Auth: HTTP bearer

Query parameters

scopestring

Filter by scope, prefix-matched: "user" matches owner context and every saved playbook, "user:playbook:" every saved playbook.

typestring

Filter by type (e.g. "playbook")

limitinteger

Max entries to return (default 20, max 50). Paginate with offset for more.

offsetinteger

Pagination offset

fullContentboolean

Return full content instead of 200-char preview. Use only when retrieving a specific entry (combine with type+scope filters).

Response

Context entries

successtrue required
totalinteger required

Total matching entries

hasMoreboolean required
offsetinteger required

Where this page started. Add the row count to it for the next page.

creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes