List Supplemental Documents

Changed on
get/entity_supplemental_documents

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/entity_supplemental_documents
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

entity_idstring required

The identifier of the Entity to list supplemental documents for.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

Supplemental Document List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "created_at": "2020-01-31T23:59:59Z",
      "entity_id": "entity_n8y8tnk2p9339ti393yi",
      "file_id": "file_makxrc67oh9l6sg7w9yc",
      "idempotency_key": null,
      "type": "entity_supplemental_document"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes