Documents

List all documents

List all documents under the platform. Filtered results can be retrieved with extra parameters in the query.

get/documents

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/documents
  • Auth: HTTP basic

Query parameters

created.gtstring date-time

Return results where the created_at field is greater than this value.

created.gtestring date-time

Return results where the created_at field is greater than or equal to this value.

created.ltstring date-time

Return results where the created_at field is less than this value.

created.ltestring date-time

Return results where the created_at field is less than or equal to this value.

descriptionstring

Filter documents by description.

ending_beforestring

A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo, your subsequent call can include ending_before=foo_ZXhhbXBsZQo in order to fetch the previous page of the list.

file_namestring

Filter documents by file name.

limitinteger

A limit on the number of objects to be returned, between 1 and 100. The default is 10.

starting_afterstring

A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.

tagstring

Filter documents by tag.

typestring

Filter documents by type.

Response

Successful response

has_moreboolean required

Whether more documents are available

Example response

{
  "documents": [
    {
      "id": "docu_2x8gszy5folpA9s0TOCseE9ABDM",
      "size": 204800
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.