# List briefs

Retrieves a list of briefs in your organization.

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

## Security:

  - `HTTPBearer` (unknown)
    http bearer JWT

## Query parameters:

  - `name` (any)
    The name of the brief to filter the list of briefs by. Supports partial matches, for example, if you specify 'summer', it will match briefs with names like 'Summer Campaign Brief' or '2026 Summer Product Launch Brief'.

  - `status` (any)
    The status of the brief, such as draft, active, or archived.

  - `creator_id` (any)
    The unique identifier of the user who created the brief.

  - `type_id` (any)
    The unique identifier of the brief type to filter briefs by. To get the list of brief type IDs, you can use the [List brief types](#operation/list-brief_types) endpoint.

  - `sort_by` (any)
    The field by which to sort the list of briefs.

## 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 briefs matching the query criteria.
    Example: 10

  - `data` (array)

  - `data.id` (string)
    The unique identifier of the brief.
    Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

  - `data.icon` (any)
    The icon associated with the brief.

  - `data.name` (string)
    The name of the brief.
    Example: New Summer Campaign Brief

  - `data.status` (string)
    The status of the brief. Draft by default.
    Example: Draft

  - `data.locale` (string)
    The locale code in the format xx-XX.
    Example: en-us

  - `data.fields` (object)
    Dictionary of field names to their values.

  - `data.isTemplate` (boolean)

  - `data.contributors` (any)
    A list of contributors associated with the brief.

  - `data.createdBy` (any)
    The user who created the brief.
    Example: user-12345

  - `data.createdBy.type` (string)
    The type of the link, which is always 'ExternalLink' for this model.
    Example: ExternalLink

  - `data.createdBy.relatedSystem` (string)
    Represents the related system reference for external links
    Enum: "contenthub", "mms", "ai", "xmcloud", "co"

  - `data.createdBy.relatedType` (any)
    The type of the related entity in the external system, or null if not specified.
    Example: Dashboard

  - `data.createdBy.id` (string)
    The unique identifier of the related entity in the external system.
    Example: dashboard-12345

  - `data.createdOn` (any)
    The ISO 8601 timestamp when the brief was created.
    Example: 2026-01-15T10:30:00Z

  - `data.updatedBy` (any)
    The user who last updated the brief.
    Example: user-67890

  - `data.updatedOn` (any)
    The ISO 8601 timestamp when the brief was last updated.
    Example: 2026-04-01T08:00:00Z

  - `data.briefType` (any)

  - `data.briefType.type` (string)

  - `data.briefType.relatedType` (string)

  - `data.briefType.id` (string)

  - `data.briefType.uri` (any)

## 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.