> ## Documentation Index > Fetch the complete documentation index at: https://docs.heralded.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Actions > Proposed actions (group new) come in the brand's order, first priority first; other groups newest first. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/actions openapi: 3.1.0 info: description: >- Read-only access to one organization's brands, as the member who created the API key. Each key may make 120 requests a minute. Every error is an RFC 9457 problem (`application/problem+json`) whose `code` names it. summary: Read your brands' AI visibility in Heralded. title: Heralded API version: '1' servers: - url: https://api.heralded.ai security: [] paths: /v1/brands/{brand_id}/actions: get: tags: - v1 summary: Get Actions description: >- Proposed actions (group new) come in the brand's order, first priority first; other groups newest first. operationId: listActions parameters: - in: path name: brand_id required: true schema: format: uuid title: Brand Id type: string - description: Include only scans up to this completed scan id. in: query name: as_of required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Include only scans up to this completed scan id. title: As Of - in: query name: limit required: false schema: default: 20 maximum: 100 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer - in: query name: cursor required: false schema: anyOf: - maxLength: 4096 type: string - type: 'null' title: Cursor - in: query name: group required: false schema: anyOf: - enum: - new - your_input - dispatched - scheduled - waiting - settled - withdrawn type: string - type: 'null' title: Group responses: '200': content: application/json: schema: $ref: '#/components/schemas/V1Actions' description: Successful Response '400': content: application/problem+json: example: code: invalid_cursor detail: The cursor is invalid or belongs to a different query. instance: example-request-id status: 400 title: Bad Request type: about:blank schema: $ref: '#/components/schemas/Problem' description: The cursor is invalid or belongs to a different query. '401': content: application/problem+json: example: code: invalid_token detail: >- The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired. instance: example-request-id status: 401 title: Unauthorized type: about:blank schema: $ref: '#/components/schemas/Problem' description: No API key, or one that is unknown, revoked or expired. headers: WWW-Authenticate: schema: example: Bearer type: string '404': content: application/problem+json: example: code: not_found detail: Nothing here that this API key can read. instance: example-request-id status: 404 title: Not Found type: about:blank schema: $ref: '#/components/schemas/Problem' description: No such brand or answer, or the key's owner cannot read it. '409': content: application/problem+json: example: code: workspace_archived detail: The API key's organization is archived. instance: example-request-id status: 409 title: Conflict type: about:blank schema: $ref: '#/components/schemas/Problem' description: The API key's organization is archived. '422': content: application/problem+json: example: code: invalid_request detail: The request's parameters are invalid; `errors` names each one. errors: - loc: - query - limit msg: Input should be less than or equal to 100 type: less_than_equal instance: example-request-id status: 422 title: Unprocessable Content type: about:blank schema: $ref: '#/components/schemas/ValidationProblem' description: A path or query parameter is invalid. '429': content: application/problem+json: example: code: rate_limited detail: >- This caller is past its requests for the minute. Retry after the seconds in Retry-After. instance: example-request-id rate_limit: limit: 120 remaining: 0 reset: 60 window: 60 status: 429 title: Too Many Requests type: about:blank schema: $ref: '#/components/schemas/RateLimitProblem' description: The API key made more than 120 requests in the minute. headers: Retry-After: description: Seconds until the key may call again. schema: example: 60 type: integer security: - apiKey: [] components: schemas: V1Actions: examples: - actions: - completed_at: '2026-09-01T10:00:00Z' created_at: '2026-08-15T10:00:00Z' delivered_at: '2026-09-01T10:00:00Z' detail: Answers comparing agency CRMs cite Rival's page, not yours. group: settled id: 9a7b5c3d-1e2f-4a6b-8c0d-2e4f6a8b0c1d kind: create_content member: writer outcome: verified_up paid_off_at: '2026-09-08T10:00:00Z' stage: verify started_at: '2026-08-16T10:00:00Z' title: Publish a comparison page against Rival limit: 20 offset: 0 total: 1 properties: actions: items: $ref: '#/components/schemas/V1Action' title: Actions type: array limit: title: Limit type: integer meta: $ref: '#/components/schemas/Meta' description: Normalized query and newest included scan. next_cursor: anyOf: - type: string - type: 'null' description: >- Pass as cursor with the same query to read the next page; null at the end. title: Next Cursor offset: title: Offset type: integer total: title: Total type: integer required: - meta - next_cursor - total - limit - offset - actions title: V1Actions type: object Problem: description: |- An RFC 9457 problem. `type` is always `about:blank`, so `title` is the status's name, and `code` is what a client branches on. properties: code: title: Code type: string detail: title: Detail type: string instance: default: '' title: Instance type: string status: title: Status type: integer title: title: Title type: string type: const: about:blank default: about:blank title: Type type: string required: - type - title - status - detail - code - instance title: Problem type: object ValidationProblem: properties: code: title: Code type: string detail: title: Detail type: string errors: items: $ref: '#/components/schemas/ValidationIssue' title: Errors type: array instance: default: '' title: Instance type: string status: title: Status type: integer title: title: Title type: string type: const: about:blank default: about:blank title: Type type: string required: - type - title - status - detail - code - instance - errors title: ValidationProblem type: object RateLimitProblem: properties: code: title: Code type: string detail: title: Detail type: string instance: default: '' title: Instance type: string rate_limit: $ref: '#/components/schemas/RateLimitValues' status: title: Status type: integer title: title: Title type: string type: const: about:blank default: about:blank title: Type type: string required: - type - title - status - detail - code - instance - rate_limit title: RateLimitProblem type: object V1Action: properties: completed_at: anyOf: - format: date-time type: string - type: 'null' title: Completed At created_at: format: date-time title: Created At type: string delivered_at: anyOf: - format: date-time type: string - type: 'null' description: >- When the result went live, was sent or was published; null on dismissed work. title: Delivered At detail: anyOf: - type: string - type: 'null' title: Detail evidence: anyOf: - $ref: '#/components/schemas/TaskEvidence' - type: 'null' description: Linked prompts and rendered answer counts from the latest report. group: enum: - new - your_input - dispatched - scheduled - waiting - settled - withdrawn title: Group type: string holder: anyOf: - enum: - you - heralded - waiting type: string - type: 'null' description: >- Who holds the work: you, Heralded or a third party; null when nobody holds it. title: Holder id: format: uuid title: Id type: string kind: title: Kind type: string member: anyOf: - enum: - writer - publicist - engineer - analyst type: string - type: 'null' description: The responsible team member; null for setup and prompt tracking. title: Member not_seen_since_run: anyOf: - type: integer - type: 'null' description: First read that stopped seeing this suggestion; null when seen. title: Not Seen Since Run note: anyOf: - $ref: '#/components/schemas/TaskNote' - type: 'null' description: Task explanation with a live job step. outcome: anyOf: - enum: - verified_up - no_move - not_measured - dismissed type: string - type: 'null' title: Outcome paid_off_at: anyOf: - format: date-time type: string - type: 'null' description: >- When verification credited a positive measured gain; null on dismissed work. title: Paid Off At placed_position: anyOf: - type: integer - type: 'null' description: Position in the brand's proposed order; null when Heralded ranks it. title: Placed Position preview: anyOf: - type: string - type: 'null' description: >- Up to 400 characters of draft opening, email recipient and subject, or planned change while waiting on you. title: Preview stage: description: 'The work''s stage: observe, decide, do or verify.' enum: - observe - decide - do - verify title: Stage type: string started_at: anyOf: - format: date-time type: string - type: 'null' description: The task's first start by Heralded; null on dismissed work. title: Started At title: anyOf: - type: string - type: 'null' title: Title required: - placed_position - not_seen_since_run - evidence - note - id - title - detail - kind - member - started_at - delivered_at - paid_off_at - preview - group - holder - stage - outcome - created_at - completed_at title: V1Action type: object Meta: properties: data_as_of: anyOf: - $ref: '#/components/schemas/DataAsOf' - type: 'null' query: additionalProperties: $ref: '#/components/schemas/JsonValue' title: Query type: object required: - query - data_as_of title: Meta type: object ValidationIssue: properties: loc: items: anyOf: - type: string - type: integer title: Loc type: array msg: title: Msg type: string type: title: Type type: string required: - loc - msg - type title: ValidationIssue type: object RateLimitValues: properties: limit: title: Limit type: integer remaining: title: Remaining type: integer reset: title: Reset type: integer window: title: Window type: integer required: - limit - window - remaining - reset title: RateLimitValues type: object TaskEvidence: properties: answers_link: anyOf: - $ref: '#/components/schemas/AnswersLink' - type: 'null' prompts: items: $ref: '#/components/schemas/TaskPromptEvidence' title: Prompts type: array required: - prompts - answers_link title: TaskEvidence type: object TaskNote: properties: how_well_know: title: How Well Know type: string short_form: title: Short Form type: string what_i_need_from_you: title: What I Need From You type: string what_ill_do: title: What Ill Do type: string whats_happening: title: Whats Happening type: string why_it_matters: title: Why It Matters type: string required: - whats_happening - why_it_matters - what_ill_do - what_i_need_from_you - how_well_know - short_form title: TaskNote type: object DataAsOf: properties: completed_at: format: date-time title: Completed At type: string id: format: uuid title: Id type: string required: - id - completed_at title: DataAsOf type: object JsonValue: {} AnswersLink: properties: href: title: Href type: string required: - href title: AnswersLink type: object TaskPromptEvidence: properties: answer_count: title: Answer Count type: integer answers_link: $ref: '#/components/schemas/AnswersLink' named_count: title: Named Count type: integer prompt_uid: format: uuid title: Prompt Uid type: string text: anyOf: - type: string - type: 'null' title: Text required: - prompt_uid - text - named_count - answer_count - answers_link title: TaskPromptEvidence type: object securitySchemes: apiKey: description: 'An API key, sent as `Authorization: Bearer hrld_...`.' scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.