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

> 特定の CRM オブジェクトのレコード一覧を取得します。
ワークスペースに公開されているレコードのみ返します。
クエリパラメータは `limit` / `cursor` のみ受け付けます（未知のパラメータは 400）。




## OpenAPI

````yaml /openapi.yaml get /v2/objects/{object}/records
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/{object}/records:
    get:
      summary: List CRM object records
      description: |
        特定の CRM オブジェクトのレコード一覧を取得します。
        ワークスペースに公開されているレコードのみ返します。
        クエリパラメータは `limit` / `cursor` のみ受け付けます（未知のパラメータは 400）。
      operationId: listV2ObjectRecords
      parameters:
        - $ref: '#/components/parameters/workspaceId'
        - $ref: '#/components/parameters/v2ObjectName'
        - name: limit
          in: query
          required: false
          description: 1–100（デフォルト30）
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 30
        - name: cursor
          in: query
          required: false
          description: 次ページ取得用カーソル
          schema:
            type: string
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ObjectRecordListResponse'
        '400':
          $ref: '#/components/responses/V2BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/V2NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    workspaceId:
      name: X-Workspace-Id
      in: header
      required: true
      description: ワークスペースID
      schema:
        type: string
      example: e1f2a3b4-...
    v2ObjectName:
      name: object
      in: path
      required: true
      description: '`GET /v2/objects` のレスポンスに含まれる `data[].name` を指定します。'
      schema:
        type: string
        enum:
          - deal
          - pipeline
          - stage
      example: deal
  schemas:
    V2ObjectRecordListResponse:
      type: object
      required:
        - data
        - page_info
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/V2ObjectRecord'
        page_info:
          $ref: '#/components/schemas/V2PageInfo'
    V2ObjectRecord:
      type: object
      required:
        - id
        - object
        - visibility
        - fields
        - created_at
        - updated_at
        - created_by
        - updated_by
      properties:
        id:
          type: string
        object:
          type: string
          description: レコードが属する CRM オブジェクトの API 識別子
          enum:
            - deal
            - pipeline
            - stage
          example: deal
        visibility:
          type: string
          description: |
            レコードの公開範囲です。現在の read API は `workspace` のレコードのみを返します。
          enum:
            - workspace
            - restricted
          example: workspace
        fields:
          type: object
          description: |
            各キーはオブジェクトメタデータの `fields[].name` に対応します。
            標準フィールドとカスタムフィールドを含み、値の型はフィールドメタデータによって異なります。
            `MANY_TO_ONE` リレーションは `*_id` 形式のキーで表現されます。
          additionalProperties: true
          example:
            name: Acme
            pipeline_id: pipe-1
            amount: '1200.50'
            my_note: hello
        created_at:
          type:
            - string
            - 'null'
        updated_at:
          type:
            - string
            - 'null'
        created_by:
          oneOf:
            - $ref: '#/components/schemas/V2Actor'
            - type: 'null'
        updated_by:
          oneOf:
            - $ref: '#/components/schemas/V2Actor'
            - type: 'null'
    V2PageInfo:
      type: object
      required:
        - end_cursor
        - has_next_page
      properties:
        end_cursor:
          type:
            - string
            - 'null'
        has_next_page:
          type: boolean
    V2Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
    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
    V2Actor:
      type: object
      required:
        - kind
        - name
      properties:
        kind:
          type: string
          enum:
            - member
            - api_key
            - ai
            - crm_sync
            - system
        name:
          type: string
  responses:
    V2BadRequest:
      description: 不正なリクエスト
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2Error'
    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
    V2NotFound:
      description: リソースが見つからない
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2Error'
    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

````