People

ch:people LINK RELATION , EMBEDDED RELATION

Actions

method	description
GET	View people collection
POST	Create new person
OPTIONS	Retrieve supported HTTP methods

Request parameters

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

When POSTing see Person request parameters.

See Pagination for details.

Profile

The People resource represents a collection of Person 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
ch:company	false

Embedded

Person

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/companies/b3ce3642-2061-4a76-bd9b-1b145395452a/people"
    },
    "ch:company": {
      "href": "https://merchant.test.clearhaus.com/companies/b3ce3642-2061-4a76-bd9b-1b145395452a"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:people": [...]
  }
}