Members

ch:members LINK RELATION , EMBEDDED RELATION

Actions

method	description
GET	View members collection
POST	Create new member
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required	method
email	email	true	POST
message	string	true	POST
name	string	false	POST
page¹	integer	false	GET
per_page¹	integer	false	GET

See Pagination for details.

Profile

The Members resource represents a collection of Member resources.

Properties

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

Link relations

rel	conditional
self	false
first	true
last	true
prev	true
next	true

Embedded

Member

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/members"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:members": [...]
  }
}