> ## Documentation Index
> Fetch the complete documentation index at: https://docs.frictio.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List CRM object metadata

> ワークスペースで利用できる CRM オブジェクトのメタデータ一覧を取得します。
現在取得できるのは、ディール（`deal`）、パイプライン（`pipeline`）、ステージ（`stage`）です。
各オブジェクトのフィールド定義は `GET /v2/objects/{object}` で取得できます。




## OpenAPI

````yaml /openapi.yaml get /v2/objects
openapi: 3.1.0
info:
  title: Frictio Public API
  version: 1.0.0-beta
servers:
  - url: https://public-api.frictio.ai
security:
  - ApiKeyAuth: []
paths:
  /v2/objects:
    get:
      summary: List CRM object metadata
      description: |
        ワークスペースで利用できる CRM オブジェクトのメタデータ一覧を取得します。
        現在取得できるのは、ディール（`deal`）、パイプライン（`pipeline`）、ステージ（`stage`）です。
        各オブジェクトのフィールド定義は `GET /v2/objects/{object}` で取得できます。
      operationId: listV2Objects
      parameters:
        - $ref: '#/components/parameters/workspaceId'
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ObjectMetadataListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    workspaceId:
      name: X-Workspace-Id
      in: header
      required: true
      description: ワークスペースID
      schema:
        type: string
      example: e1f2a3b4-...
  schemas:
    V2ObjectMetadataListResponse:
      type: object
      required:
        - data
        - page_info
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/V2ObjectMetadata'
        page_info:
          $ref: '#/components/schemas/V2PageInfo'
    V2ObjectMetadata:
      type: object
      required:
        - name
        - name_plural
        - label
        - label_plural
        - is_custom
        - is_active
      properties:
        name:
          type: string
        name_plural:
          type: string
        label:
          type: string
        label_plural:
          type: string
        is_custom:
          type: boolean
        is_active:
          type: boolean
        fields:
          type: array
          items:
            $ref: '#/components/schemas/V2FieldMetadata'
    V2PageInfo:
      type: object
      required:
        - end_cursor
        - has_next_page
      properties:
        end_cursor:
          type:
            - string
            - 'null'
        has_next_page:
          type: boolean
    Error:
      type: object
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          description: HTTPステータスコード
          example: 404
        message:
          type: string
          description: エラーメッセージ
          example: Meeting not found
        error:
          type: string
          description: |
            エラー種別。メッセージ文字列付きで例外が生成された場合のみ含まれます。
          example: Not Found
    V2FieldMetadata:
      type: object
      required:
        - name
        - label
        - type
        - is_nullable
        - is_unique
        - is_custom
        - is_active
      properties:
        name:
          type: string
          description: |
            フィールドの API 識別子です。レコードの `fields` のキーと一致します。
            `MANY_TO_ONE` リレーションでは `*_id` 形式です。
          example: pipeline_id
        label:
          type: string
        type:
          type: string
        is_nullable:
          type: boolean
        is_unique:
          type: boolean
        is_custom:
          type: boolean
        is_active:
          type: boolean
        options: {}
        relation:
          type: object
          properties:
            type:
              type: string
              enum:
                - MANY_TO_ONE
                - ONE_TO_MANY
            target_object:
              type: string
              description: |
                Frictio objectとのrelationの場合の参照先object名です。
            target_resource:
              type: string
              description: |
                object以外の公開resourceとのrelationの場合の参照先です。
                `workspace_member` relationでは `members` を返し、レコードの `*_id` は
                `/v1/members` の `id` と同じ公開IDです。
              example: members
  responses:
    Unauthorized:
      description: APIキーが無効、失効、期限切れ、または未指定です
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 401
            message: Invalid API key
            error: Unauthorized
    Forbidden:
      description: 権限エラー
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 403
            message: Forbidden
    TooManyRequests:
      description: レートリミット超過
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 429
            message: Too Many Requests
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````