AI agents connected to the workspace

GET

/api/v1/workspaces/{workspaceId}/agent-connections

const url = 'https://api.crossmart.io/api/v1/workspaces/example/agent-connections';
const options = {
  method: 'GET',
  headers: {cookie: 'better-auth.session_token=<better-auth.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.crossmart.io/api/v1/workspaces/example/agent-connections \
  --cookie better-auth.session_token=<better-auth.session_token>

Your own connections, or every member’s if you may manage API keys. Signed-in users only.

Authorizations

cookie

Parameters

Path Parameters

workspaceId

required

string

Responses

200

application/json

Array<object>

object

required

string format: uuid

clientId

required

The OAuth client id: a Client ID Metadata Document URL, or a registered id

string

clientName

required

The name the agent gives, such as “Claude”

string

clientRegistration

required

Whether clientName came from a verified host (metadata_document) or is only what the agent calls itself (dynamic)

string

Allowed values: metadata_document dynamic

clientVerifiedHost

required

For a metadata_document client: the host its metadata came from

string

nullable

clientUri

required

The agent’s home page

string

nullable

clientIcon

required

The agent’s logo address, from its metadata. Crossmart never fetches it.

string

nullable

userId

required

The member who connected the agent

string format: uuid

userName

required

string

userEmail

required

string

scopes

required

Array<string>

Allowed values: catalog:read catalog:write orders:read stores:write reports:read suggestions:write webhooks:write

connectedAt

required

string format: date-time

Example

[
  {
    "clientRegistration": "metadata_document",
    "scopes": [
      "catalog:read"
    ]
  }
]