Getting Available Contacts

Overview

The Get Available Contacts endpoint supports existing custom integrations that use the legacy /export/* API. New Power BI reports should use the connector-backed ClashWise report: after OAuth sign-in, its Matrix Options table supplies contact names for the projects available to the signed-in organization member without exporting contact email addresses.

Endpoint

Method: GET URL: https://api.clashwise.ai/export/contacts

Authentication

This endpoint requires Basic Authentication using your API Client ID and Secret, identical to the main Export API — use the Client ID as the username and the Client Secret as the password. To create or revoke credentials, see the Managing API Keys article in this section. Access requires an active Clash Management plan (Pro or Business), including the free trial.

---

Response format

The response is a JSON array of contact objects, ordered by name.

[
  {
    "id": "contact-guid-1",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "company": "Structural Engineering Co."
  },
  {
    "id": "contact-guid-2",
    "name": "Jane Smith",
    "email": "jane.smith@example.com",
    "company": "MEP Services Ltd."
  }
]

---

Using in an existing custom Power BI report

To create a dynamic filter for your Clash Data report in PowerBI:

1. Get Data > Web.
2. Enter the URL: https://api.clashwise.ai/export/contacts.
3. Authenticate using Basic Auth (Client ID / Secret).
4. Convert the JSON list to a table.
5. Link tables: in the "Model" view, drag the id field from your Contacts table to the recommendedContactId field in your Clash Data table.
6. Create filter: you can now use the name field from the Contacts table as a slicer to filter your visualizations.

Related topics

• Managing API Keys
• Power BI analytics (connector installation, OAuth sign-in, refresh, and revocation)