Files

Profile

The Files resource represents a collection of File resources.

Properties

name type read-only
count integer true
page integer true
per_page integer true
rel conditional
self false
first true
last true
prev true
next true
ch:application1 true
ch:person1 true
ch:dispute1 true
1
Presence depends on file ownership context.

Embedded

Additional semantics

This collection is paginated. See Pagination.

Example representation

{
  "count": 1,
  "page": 1,
  "per_page": 20,
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/files"
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:files": [...]
  }
}
Open Navigation Close Navigation