Skip to main content

List collection files

GET 
/api/v1/collections/:collection-id/files

List files of a given collection.

Request​

Path Parameters

    collection-id stringrequired

    Collection ID

Query Parameters

    offset integer

    Default value: 0

    Number of files to skip

    limit integer

    Possible values: >= 1 and <= 500

    Default value: 100

    Number of files to return

Responses​

Successful response

Schema

    result

    object[]

    required

    List of files in the collection

  • Array [

    • id stringrequired

    File ID

    name stringrequired

    File name

    type stringrequired

    File's MIME type

    status stringrequired

    Possible values: [pending, indexed, error]

    File status

    error stringnullable

    Error message if the file indexing failed

    created_at stringrequired

    Timestamp when the file was created

    user_id stringrequired

    ID of creating user

    url urirequired

    File URL

    size numbernullable

    File size in bytes

    md5_hash stringnullable

    MD5 hash of the file

    connector_id stringnullable

    ID of the connector managing the file

    connector

    object

    nullable

    id stringrequired
    name stringrequired
    type stringrequired

    Possible values: [google, onedrive, dropbox, web, gmail, jira, confluence, hubspot, zendesk, notion, slack, airtable, github, ext_web]

  • ]

Loading...