# List brief types

Retrieves a list of available brief types, including their metadata and field definitions such as field types, labels, validation rules, and other information used by AI when generating briefs.

Endpoint: GET /api/v1/brief/brief-types
Version: v2.0
Security: HTTPBearer

## Security:

  - `HTTPBearer` (unknown)
    http bearer JWT

## Header parameters:

  - `x-sc-job-id` (any)
    A unique identifier for the job, used to trace, audit, and revert actions performed by an AI agent through the Agent API.

## Response 200:

  - `200` (unknown)
    Successful response

## Response 200 fields (application/json):

  - `totalCount` (integer)
    The total number of available brief types.
    Example: 5

  - `data` (array)
    A list of available brief types.

  - `data.id` (string)
    The unique UUID of the brief type.
    Example: f2657200-e881-4027-8ddf-a9810eb9d177

  - `data.name` (string)
    The name of the brief type.
    Example: travel_campaigns

  - `data.label` (object)
    The label of the brief type, which can be localized for different languages.
    Example: {"en-us":"Travel campaigns"}

  - `data.icon` (any)
    The name of the icon associated with the brief type, which is used to visually represent the brief type in the UI.
    Example: mdiFileDocumentOutline

  - `data.iconColor` (any)
    The color of the icon associated with the brief type.
    Example: primary

  - `data.description` (any)
    The description of the brief type.
    Example: Briefs used for planning and executing travel marketing campaigns.

  - `data.fields` (array)
    The list of fields that belong to this brief type, including their configurations and metadata.

  - `data.fields.type` (string)
    The type of field in the brief type.

  - `data.fields.name` (string)
    The name of the field. Must be alphanumeric with no spaces or special characters.
    Example: TargetAudience

  - `data.fields.label` (object)
    The display label of the field, which can be localized for different languages.
    Example: {"en-us":"Target audience"}

  - `data.fields.helpText` (object)
    The text providing help or guidance for the field, which can be localized for different languages.
    Example: {"en-us":"Whether the campaign is targeting a specific audience."}

  - `data.fields.required` (boolean)
    Whether the field is required.
    Example: true

  - `data.fields.aiEditable` (boolean)
    Whether the field is editable by AI.
    Example: false

  - `data.fields.aiIntent` (any)
    The AI intent associated with the field.
    Example: This field should be used to adapt language and tone for the intended audience.

  - `data.fields.currencies` (array)
    A list of allowed currencies for the budget field, specified as ISO currency codes.
    Example: ["USD","EUR"]

  - `data.fields.helpText` (object)
    The help text for the field, which can be localized for different languages.
    Example: {"en-us":"Describe the target audience for the content, such as demographics, interests, and behaviors."}

  - `data.fields.aiContext` (any)
    The AI context for the field.
    Example: The content will be used in a hero banner on the homepage of an e-commerce website that sells healthy products.

  - `data.fields.type` (string)
    Type of the field the brief type.

  - `data.fields.calculation` (string)
    The timeline calculation constraint. Either `Flexible`, `Backward` or `Forward`.
    Example: Flexible

  - `data.fields.skipHolidays` (boolean)
    Whether to skip holidays in timeline calculations.
    Example: true

  - `data.fields.skipWeekend` (boolean)
    Whether to skip weekends in timeline calculations.
    Example: true

  - `data.fields.timezone` (string)
    The timezone to use for timeline calculations.

## Response 422:

  - `422` (unknown)
    Unprocessable entity

## Response 422 fields (application/json):

  - `detail` (array)

  - `detail.loc` (array)
    The location of the error in the request.

  - `detail.msg` (string)
    The error message.

  - `detail.type` (string)
    The type of error.

  - `detail.input` (any)
    The input that caused the error.

  - `detail.ctx` (object)
    The context in which the error occurred.