/
API for Contacts, Connections, Registrations

API for Contacts, Connections, Registrations

Owned by Matthew Garrett
Last updated: Apr 15, 2024
2 min read



Page Index

Overview

The Platform 2024.1 Release introduces a new API for retrieving a list of a licensees contacts and their details, including;

  • Phone and Address information

  • Roles they are connected in

  • Projects they’re linked to as a customer (if any)

  • Integration subscription links

Calling

It is called like this;

image-20240321-221557.png

Details to pass and what is returned

Follow the link here to see details of what you need to pass and what is returned.

Platform Subscription API

For each contact, you will get the following information

  • IsConnected - True if this contact has at least 1 active connection to the licensee. Without an active connection only public profile information for the contact is returned.

Note: if a contact is only connected to the licensee with pending connection requests the data returned will be limited for that contact.

  • Contact & Profile information 

    • When IsConnected is false only the following information is returned

      • Title

      • First name

      • Surname

      • Trading name 

      • Legal name

      • Contact type id and name

      • Profile information (Description, Industry, working for, working areas)

      • Time zone

  • Contact Details (phone/fax/email etc  Not returned when IsConnected is false

  • Connection information with the licensee (Active Connections and Requests)

    • The role id, name and connection status

  • Linked Projects the contact may be connected to as a customer.

  • Integration Subscription links - active and inactive