GET: Portfolio Contacts

Ingrid

https://api.bitsighttech.com/ratings/v1/portfolio/contacts

Get the points of contact for the companies in your portfolio.

Contacts are the users within the companies in your portfolio who are assigned as the primary recipient of communications, such as during collaboration via the Client/Vendor Access Program.

Example Request

curl https://api.bitsighttech.com/ratings/v1/portfolio/contacts -u api_token:

Example Response

[
  {
    "guid":"72bd0c20-9911-47cc-9413-2cb30c69191d",
    "company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
    "creator":"richard.kuga@saperix.com",
    "creation_date":"2020-12-14",
    "last_editor":"richard.kuga@saperix.com",
    "last_edit_date":"2020-12-14",
    "friendly_name":"Diane",
    "formal_name":"Diane Jones",
    "email":"diane@actorsfilms.us",
    "phone_number":"555-555-5555"
  }
]

Response Attributes

Field	Description
guid String [`user_guid`]	The unique identifier of the contact.
company_guid String [`entity_guid`]	The unique identifier of the contact's company.
creator String	The email of the user who created the contact.
creation_date String [`YYYY‑MM‑DD`]	The date when the contact was created.
last_editor String	The email of the user who last edited the contact.
last_edit_date String [`YYYY‑MM‑DD`]	The date when the contact was last edited.
friendly_name String	The preferred name of the contact.
formal_name String	The full name of the contact.
email String	The email address of the contact.
phone_number String	The phone number of the contact.

December 14, 2020: Added example cURL request; Added the creator, creation_date, last_editor, and last_edit_date fields.
June 19, 2019: Published.