CAcasemark
Vault Objects

List vault objects

Changed on

Retrieve the objects stored in a specific vault, oldest first, including document metadata, ingestion status, and processing statistics. Pass limit to page through large vaults: when pagination.has_more is true, the response is incomplete and pagination.next_cursor fetches the rest.

get/vault/{id}/objects

Request

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/vault/{id}/objects
  • Auth
    HTTP bearer

Path parameters

idstring required

The unique identifier of the vault

Query parameters

includeUnconfirmedboolean

Include placeholders for uploads that were never completed (awaiting_upload) or were cancelled (aborted). Excluded by default.

file_originstring
Example:{"provider":"clio"}

JSON-encoded provenance object used as a partial match. For example, {"provider":"clio"} returns objects whose file_origin contains that value.

limitinteger

Objects per page (1-200). Omit to receive every object. Supplying a cursor without a limit uses 50.

cursorstring

Opaque continuation cursor from pagination.next_cursor of the previous page. Must be replayed with the same API key scope and the same query, file_origin and includeUnconfirmed values that produced it.

querystring

Case-insensitive substring match on the filename.

include_totalsboolean

When true, adds totals covering every object matching the filters, not just this page. Request it once per filter change rather than on every page.

Response

Successfully retrieved vault objects

vaultIdstring required

The ID of the vault

countnumber required

Number of objects in this response. Equals the vault total only when pagination.has_more is false; use totals.objects for the total across pages.

Changes

  • a21d188f4b21Revision changes
    • info

      api tag Vault Objects added

    • info

      api tag Vaults removed

    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter file_origin

    • info

      added the new optional query request parameter includeUnconfirmed

    • info

      added the new optional query request parameter include_totals

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter query

    • 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

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status