Property Deck

Property Deck

  • Authentication
  • Getting Started

›API

Getting Started

  • Introduction
  • Authentication
  • Rate Limiting
  • Concepts

API

  • Attachments
  • Competencies
  • Custom Fields
  • Contacts
  • Properties
  • Notes
  • Reminders
  • Statuses
  • Types

Competencies

Competencies are skills which belong to a Contact.

Object Definition

FieldTypeDescription
uuidstringUnique identifier for the object
created_atstringISO 8601 datetime when the competency was originally created
updated_atstringISO 8601 datetime when the attachment was last updated
labelstringName of the competency

List all Competencies

Retrieve a paginated list of all the accounts Competencies. GET /competencies.

Filters

FieldTypeDescription
uuidstringExact 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

FieldTypeDescription
labelstringName 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

FieldTypeDescription
labelstringName 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.

← AttachmentsCustom Fields →
  • Object Definition
  • List all Competencies
    • Filters
    • Example Response
  • Get a single Competency
    • Example Response
  • Creating a Competency
  • Updating a Competency
  • Deleting a Competency
Property Deck
Docs
IntroductionAuthenticationRate LimitingConcepts
API
AttachmentsCompetenciesCustom FieldsContactsProperties
 
NotesRemindersStatusesTypes
Copyright © 2018 Radweb Ltd