Api Keys

ch:api-keys LINK RELATION , EMBEDDED RELATION

Actions

method	description
GET	View api keys collection
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required	method
page¹	integer	false	GET
per_page¹	integer	false	GET

See Pagination for details.

Profile

The Api Keys resource represents a collection of Api Key resources.

Properties

name	type	read-only
count	integer	true
page	integer	true
per_page	integer	true

Link relations

rel	conditional
self	false
first	true
prev	true
next	true

Embedded

Api Key

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/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4/api-keys"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:api-keys": [...]
  }
}