CLcloudglue
Collections

List all extracted entities for files in a collection

Changed on

List all extracted entities for files in a collection. This API is only available when a collection is created with collection_type 'entities'

get/collections/{collection_id}/entities

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Path parameters

collection_idstring required

The ID of the collection

Query parameters

limitinteger

Maximum number of files to return

offsetinteger

Number of files to skip

order'added_at' | 'filename'

Order the files by a specific field

sort'asc' | 'desc'

Sort the files in ascending or descending order

added_beforestring date

Filter files added before a specific date (YYYY-MM-DD format), in UTC timezone

added_afterstring date

Filter files added after a specific date (YYYY-MM-DD format), in UTC timezone

Response

A list of file entities in the collection

object'list' required

Object type, always 'list'

totalinteger required

Total number of files with entities matching the query

limitinteger required

Number of items returned in this response

offsetinteger required

Offset from the start of the list

Changes

  • 23d3f240819fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1d5d6115c0d0Revision changes
    • breaking

      for the query request parameter limit, default value 50 was removed

    • breaking

      for the query request parameter offset, default value 0 was removed

    • breaking

      for the query request parameter order, default value added_at was removed

    • breaking

      for the query request parameter sort, default value desc was removed