Types

Types belongs to a Contact.

Object Definition

Field	Type	Description
uuid	string	Unique identifier for the object
created_at	string	ISO 8601 datetime when the competency was originally created
updated_at	string	ISO 8601 datetime when the attachment was last updated
label	string	Name of the type

List all Types

Retrieve a paginated list of all the accounts Types. GET /types.

Filters

Field	Type	Description
uuid	string	Exact match for the type's uuid

Example Response

{
  "data": [
    {
      "uuid": "472675ea-18c6-4a89-8331-9c96ccd8c683",
      "created_at": "2018-08-02T16:34:34+01:00",
      "updated_at": "2018-08-02T16:34:42+01:00",
      "label": "Tenant"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Get a single Type

Retrieve a single type by it's uuid. GET /types/:uuid.

Example Response

{
  "data": {
    "uuid": "472675ea-18c6-4a89-8331-9c96ccd8c683",
    "created_at": "2018-08-02T16:34:34+01:00",
    "updated_at": "2018-08-02T16:34:42+01:00",
    "label": "Tenant"
  }
}

Creating a Type

Perform a POST request to the /types endpoint. This endpoint will return a HTTP 201 status code on success.

Input

Field	Type	Description
label	string	Name of the type

Updating a Type

Perform a PUT request to the /types/:uuid endpoint. This endpoint will return a HTTP 200 status code on success.

Input

Field	Type	Description
label	string	Name of the type

Deleting a Type

Perform a DELETE request to the /types/:uuid endpoint. This endpoint will return a HTTP 204 status code on success.

This endpoint will automatically remove the Type from any Contacts.