February 17, 2026

API Changes

Retrieve Client Access Details for a Contact

You can now retrieve a list of clients a Contact has access to in Karbon for Clients along with the access level that has been granted.

Note that ClientAccess is a read-only property and access to Karbon for Clients cannot be created or removed via the API.

To use this feature, include the querystring parameter $expand=ClientAccess in your GET request to the /v3/Contacts/{ContactKey} endpoint. This will return an array of associated clients this contact has access to in Karbon for Clients.

For example, a request to /v3/Contacts/X2C4ffW1Fqv?$expand=ClientAccess will include the following ClientAccess array in the response:

"ClientAccess": [
    {
        "ClientKey": "26L7dsVZ5DzR",
        "ClientType": "Contact",
        "AccessLevel": "Limited"
    },
    {
        "ClientKey": "4FVM9lWhb4mp",
        "ClientType": "Organization",
        "AccessLevel": "FullAccess"
    }
]

Based on this response, you can see that the contact X2C4ffW1Fqv has access to two clients in Karbon for Clients. They have limited access the person 26L7dsVZ5DzR and full access the orgnization 4FVM9lWhb4mp.

The AccessLevel property will be either Limited or FullAccess, corresponding to the access level set for that contact in Karbon.