> ## 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 Organization Brands

> Portfolio rows with 1w figures, paired change and actions waiting.

Set managed=true for accounts this manager actively manages. Brand grants
alone open neither portfolio. Portfolio reads are live, with no scan pin.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/organizations/{organization_id}/brands
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/organizations/{organization_id}/brands:
    get:
      tags:
        - v1
      summary: Get Organization Brands
      description: >-
        Portfolio rows with 1w figures, paired change and actions waiting.


        Set managed=true for accounts this manager actively manages. Brand
        grants

        alone open neither portfolio. Portfolio reads are live, with no scan
        pin.
      operationId: getOrganizationBrands
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            format: uuid
            title: Organization Id
            type: string
        - 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: managed
          required: false
          schema:
            default: false
            title: Managed
            type: boolean
        - in: query
          name: managed_account_id
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            title: Managed Account Id
        - in: query
          name: sort
          required: false
          schema:
            anyOf:
              - enum:
                  - score
                  - actions
                  - name
                type: string
              - type: 'null'
            title: Sort
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/V1Portfolio'
                  - $ref: '#/components/schemas/V1ManagerPortfolio'
                title: Response Getorganizationbrands
          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:
    V1Portfolio:
      properties:
        brands:
          items:
            $ref: '#/components/schemas/PortfolioBrandRow'
          title: Brands
          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
        organization_id:
          format: uuid
          title: Organization Id
          type: string
        total:
          title: Total
          type: integer
      required:
        - meta
        - next_cursor
        - total
        - limit
        - offset
        - organization_id
        - brands
      title: V1Portfolio
      type: object
    V1ManagerPortfolio:
      properties:
        accounts:
          items:
            $ref: '#/components/schemas/ManagerPortfolioAccount'
          title: Accounts
          type: array
        brand_total:
          title: Brand Total
          type: integer
        brands:
          items:
            $ref: '#/components/schemas/ManagerPortfolioBrandRow'
          title: Brands
          type: array
        limit:
          title: Limit
          type: integer
        manager_id:
          title: Manager Id
          type: string
        manager_name:
          title: Manager Name
          type: string
        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
        organization_id:
          format: uuid
          title: Organization Id
          type: string
        total:
          title: Total
          type: integer
      required:
        - meta
        - next_cursor
        - total
        - limit
        - offset
        - organization_id
        - manager_id
        - manager_name
        - brands
        - accounts
        - brand_total
      title: V1ManagerPortfolio
      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
    PortfolioBrandRow:
      description: One brand of the portfolio table.
      properties:
        actions_waiting:
          default: 0
          title: Actions Waiting
          type: integer
        axes:
          default: []
          items:
            $ref: '#/components/schemas/PortfolioAxis'
          title: Axes
          type: array
        brand_id:
          title: Brand Id
          type: string
        data_as_of:
          anyOf:
            - $ref: '#/components/schemas/DataAsOf'
            - type: 'null'
        domain:
          title: Domain
          type: string
        movement_since_deep_read:
          default: 0
          title: Movement Since Deep Read
          type: integer
        score:
          anyOf:
            - type: integer
            - type: 'null'
          title: Score
        score_change:
          anyOf:
            - $ref: '#/components/schemas/PairedChange'
            - type: 'null'
      required:
        - brand_id
        - domain
        - data_as_of
        - score
        - score_change
        - axes
        - actions_waiting
        - movement_since_deep_read
      title: PortfolioBrandRow
      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
    ManagerPortfolioAccount:
      properties:
        brand_count:
          title: Brand Count
          type: integer
        name:
          title: Name
          type: string
        organization_id:
          title: Organization Id
          type: string
      required:
        - organization_id
        - name
        - brand_count
      title: ManagerPortfolioAccount
      type: object
    ManagerPortfolioBrandRow:
      description: |-
        One brand of the manager portfolio: the organization row's numbers
        beside the brand's name and the account that owns it.
      properties:
        actions_waiting:
          default: 0
          title: Actions Waiting
          type: integer
        axes:
          default: []
          items:
            $ref: '#/components/schemas/PortfolioAxis'
          title: Axes
          type: array
        brand_id:
          title: Brand Id
          type: string
        data_as_of:
          anyOf:
            - $ref: '#/components/schemas/DataAsOf'
            - type: 'null'
        domain:
          title: Domain
          type: string
        managed_account:
          $ref: '#/components/schemas/PortfolioManagedAccount'
        movement_since_deep_read:
          default: 0
          title: Movement Since Deep Read
          type: integer
        name:
          title: Name
          type: string
        score:
          anyOf:
            - type: integer
            - type: 'null'
          title: Score
        score_change:
          anyOf:
            - $ref: '#/components/schemas/PairedChange'
            - type: 'null'
      required:
        - brand_id
        - domain
        - data_as_of
        - score
        - score_change
        - axes
        - actions_waiting
        - movement_since_deep_read
        - name
        - managed_account
      title: ManagerPortfolioBrandRow
      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
    PortfolioAxis:
      description: |-
        One axis of one brand over the last week, with its move.

        `value` is null where the week could not measure the axis — a gap, not a
        zero. `change` is the figures read's paired change and is null where no
        earlier week was read: a first read has moved from nothing.
      properties:
        axis:
          title: Axis
          type: string
        change:
          anyOf:
            - $ref: '#/components/schemas/PairedChange'
            - type: 'null'
        value:
          anyOf:
            - type: number
            - type: 'null'
          title: Value
      required:
        - axis
        - value
        - change
      title: PortfolioAxis
      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
    PairedChange:
      description: |-
        A figure's change over the selected window, in points, with its 95%
        range (`app.scans.scoring.axes.change_payload`). `real` is whether the
        paired test over the prompt × engine cells both reads measured says it
        moved; a surface announces only a real change.
      properties:
        delta:
          title: Delta
          type: number
        high:
          title: High
          type: number
        low:
          title: Low
          type: number
        real:
          title: Real
          type: boolean
      required:
        - delta
        - low
        - high
        - real
      title: PairedChange
      type: object
    JsonValue: {}
    PortfolioManagedAccount:
      description: |-
        The managed account a manager portfolio row belongs to: the table's
        account column and the key its account filter uses.
      properties:
        name:
          title: Name
          type: string
        organization_id:
          title: Organization Id
          type: string
      required:
        - organization_id
        - name
      title: PortfolioManagedAccount
      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.