# List File Records ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/files: get: summary: List File Records deprecated: false description: >- Returns list of file records. ## Query Parameters Parameter | Type | Default | Description -------------- | ----------- | --------- | ----------- per_page | integer | 100 | Number of results to be returned per request (100 is the maximum) page_no | integer | 1 | Number of results page ids | integer[] | null | When given, returned file records are filtered by id file_identifiers | string[] | null | When given, returned file records are filtered by file's type & identifier. Format: `#{type}:#{identifier}`. with_inactive | boolean | false | When true fetches also inactive file records ## Example ```shell curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/files' \ --header 'x-product-name: default' \ --header 'x-user-agent: CURL manual test' \ --header 'x-customer: 447' \ --header 'authorization: Bearer JWTTOKEN' ``` When successful, returns object containing [file record](doc-341715#filerecord-model) ```json { "file_records": {} // see: FileRecord model } ``` tags: - API Reference/Management API/Files parameters: - name: Content-Type in: header description: '[Details](doc-341635)' required: true example: application/json schema: type: string default: application/json const: application/json - name: X-User-Agent in: header description: Arbitrary identifier of your client. [Details](doc-341635) required: true example: '{{X_USER_AGENT}}' schema: type: string default: '{{X_USER_AGENT}}' - name: X-Product-Name in: header description: API Product for API context. [Details](doc-341635) required: true example: '{{PRODUCT_NAME}}' schema: type: string default: '{{PRODUCT_NAME}}' - name: X-Loyalty-Club-Slug in: header description: LoyaltyClub for API context. [Details](doc-342138) required: false example: '{{LOYALTY_CLUB_SLUG}}' schema: type: string default: '{{LOYALTY_CLUB_SLUG}}' - name: X-Customer in: header description: Customer for API context. [Details](doc-342139) required: false example: '{{CUSTOMER_ID}}' schema: type: string default: '{{CUSTOMER_ID}}' - name: Authorization in: header description: '[Member](doc-342129) or [User](doc-342130) Authorization.' required: false example: Bearer {{_OAUTH_TOKEN}} schema: type: string default: Bearer {{_OAUTH_TOKEN}} - name: X-Client-Authorization in: header description: '[Token](doc-342128) Authorization.' example: '{{API_TOKEN}}' schema: type: string default: '{{API_TOKEN}}' requestBody: content: application/json: schema: type: object properties: ids: type: array items: type: integer description: When given, returned file records are filtered by id file_identifiers: type: array items: type: string description: >- When given, returned file records are filtered by file's type & identifier. Format: `#{type}:#{identifier}` file_type: type: string description: >- When given, returned file records are filtered by file's type with_inactive: type: boolean description: When given, fetches also inactive file records x-apidog-orders: - ids - file_identifiers - file_type - with_inactive x-apidog-ignore-properties: [] examples: {} responses: '200': description: '' content: application/json: schema: type: object properties: file_records: type: object properties: id: type: integer type: type: string identifier: type: string nullable: true sub_identifier: type: string nullable: true customer_id: type: integer nullable: true loyalty_club_id: type: integer nullable: true user_id: type: string nullable: true url: type: 'null' filename: type: string nullable: true mime_type: type: string size: type: integer created_at: type: string updated_at: type: string active: type: boolean last_active_at: type: 'null' duplicated_from_file_record_id: type: 'null' x-apidog-orders: - 01KYPRG0D74P9HFH4Y812CZKJY required: - id - type - identifier - customer_id - loyalty_club_id - user_id - url - filename - mime_type - size - created_at - updated_at - active - last_active_at - duplicated_from_file_record_id x-apidog-refs: 01KYPRG0D74P9HFH4Y812CZKJY: $ref: '#/components/schemas/FileRecord' x-apidog-ignore-properties: - id - type - identifier - sub_identifier - customer_id - loyalty_club_id - user_id - url - filename - mime_type - size - created_at - updated_at - active - last_active_at - duplicated_from_file_record_id x-apidog-orders: - file_records required: - file_records x-apidog-ignore-properties: [] headers: {} x-apidog-name: Success security: [] x-apidog-folder: API Reference/Management API/Files x-apidog-status: pending x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511246-run components: schemas: FileRecord: type: object properties: id: type: integer type: type: string identifier: type: string nullable: true sub_identifier: type: string nullable: true customer_id: type: integer nullable: true loyalty_club_id: type: integer nullable: true user_id: type: string nullable: true url: type: 'null' filename: type: string nullable: true mime_type: type: string size: type: integer created_at: type: string updated_at: type: string active: type: boolean last_active_at: type: 'null' duplicated_from_file_record_id: type: 'null' required: - id - type - identifier - customer_id - loyalty_club_id - user_id - url - filename - mime_type - size - created_at - updated_at - active - last_active_at - duplicated_from_file_record_id x-apidog-orders: - id - type - identifier - sub_identifier - customer_id - loyalty_club_id - user_id - url - filename - mime_type - size - created_at - updated_at - active - last_active_at - duplicated_from_file_record_id x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.mpc.dev.placewise.com description: Staging security: [] ```