Skip to main content

Contacts

Overview​

The Contacts service is a core component of the Decisively platform, used to manage contact (or, in the case of EdWard, employee) records. It forms part of a broader CRM capability within Decisively.

Typically, contact records are created automatically through various rule configurations. In this mode, the records maintain traceability of decisions, showing how data is collected and used across different rule sets.

EdWard can be used to manage your entire employee database, acting as the source of truth. In this setup, every piece of employee information is defined through rules and has traceability across decision-making processes.

However, in most cases, EdWard is not the source of truth. Instead, employee records are synchronised from your existing system into EdWard (see Contacts)

tip

All endpoints in this service use the Base URL of /contacts

1. Get a Contact​

  • Endpoint: /{id}
  • Method: GET
  • Summary: Get a contact

Request Parameters:​

  • id: The id of the contact record
  • time: Contact data recorded through Decisively will be temporal in nature. Pass a timestamp here to return data at this moment in time. This does not effect custom data

Response:​

{
  "id": "GUID",
  "firstName": "",
  "lastName": "",
  "name": "", // Name is usually used to hold either the full name of a person or the name of an entity that doesn't use firstNames (eg: a company),
  "created": "2025-01-01T12:34:00Z",
  "lastModified": "2025-01-01T12:34:00Z",
  // any additional fields that are created through the Decisively rules system
  "custom": {
    // Any fields added through external systems into Decisively
  }
}

2. Get all Contacts​

  • Endpoint: /
  • Method: GET
  • Summary: Get all contacts

Request Parameters:​

  • time: Contact data recorded through Decisively will be temporal in nature. Pass a timestamp here to return data at this moment in time. This does not effect custom data

Response:​

{
  "total": 1, // Total number of tasks in the system. Note: only 10 is returned at a time by default
  "items": [{
    // same response as the get task response (except only the base fields of id, name, firstName, lastName, created, lastModified are returned)
  }]
}

3. Create a Contact​

  • Endpoint: /
  • Method: POST
  • Summary: Create a contact. Note: only admins can add contacts

Request Parameters:​

JSON body:

{
  "id": "any", // this can be ommitted and have an auto-generated GUID
  "firstName": "",
  "lastName": "",
  "name": "",
  // Any other fields - these will be inserted into "custom" though 
}

Response:​

Same as the Get Contact response

4. Update a Contact​

  • Endpoint: /
  • Method: PATCH
  • Summary: Update a contact. Note: only admins can update contacts

Request Parameters:​

JSON body:

{
  "firstName": "",
  "lastName": "",
  "name": "",
  // Any other fields - these will be inserted into "custom" though 
}

Response:​

Same as the Get Contact response

Authentication​

Please refer to the authentication guide to understand how to authenticate your requests before interacting with the API.

Error Handling​

Please refer to the error handling guide for details on common errors and how to handle them.