Competencies
Competencies are skills which belong 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 competency |
List all Competencies
Retrieve a paginated list of all the accounts Competencies. GET /competencies.
Filters
| Field | Type | Description |
|---|---|---|
uuid | string | Exact match for the competency's uuid |
Example Response
{
"data": [
{
"uuid": "f4818438-5690-47ec-8628-12b933cabae3",
"created_at": "2018-08-02T14:32:22+01:00",
"updated_at": "2018-08-02T14:32:26+01:00",
"label": "Photography"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}
Get a single Competency
Retrieve a single competency by it's uuid. GET /competencies/:uuid.
Example Response
{
"data": {
"uuid": "7de4bab0-3aaf-4755-b8e7-5f88baf38e72",
"created_at": "2018-08-02T14:32:22+01:00",
"updated_at": "2018-08-02T14:32:26+01:00",
"label": "Photography"
}
}
Creating a Competency
Perform a POST request to the /competencies endpoint. This endpoint will return a HTTP 201 status code on success.
Input
| Field | Type | Description |
|---|---|---|
label | string | Name of the competency |
Updating a Competency
Perform a PUT request to the /comptencies/:uuid endpoint. This endpoint will return a HTTP 200 status code on success.
Input
| Field | Type | Description |
|---|---|---|
label | string | Name of the competency |
Deleting a Competency
Perform a DELETE request to the /competencies/:uuid endpoint. This endpoint will return a HTTP 204 status code on success.
This endpoint will automatically remove the Competency from any Contacts.
