Collaborator

self LINK RELATION

Actions

method	description
GET	View
DELETE	Remove
OPTIONS	Retrieve supported HTTP methods

Request parameters

No request parameters.

Profile

A Collaborator represents a user that has been given access to an Application.

See ch:collaborators for more information on inviting collaborators.

Properties

name	type
email	email
name	string

Link relations

rel	conditional
self	false
ch:application	false

Additional semantics

No additional semantics.

Example representation

{
  "name": "Clearhaus A/S",
  "email": "support@clearhaus.com",
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/collaborators/a2739d19-2b66-4aa4-bd61-9836d84439dc"
    },
    "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"
      }
    ]
  }
}