Get Platform Workspaces

GET

/exports/platform-workspaces

Returns the list of workspaces available for a stored credential.

Currently only supported for INSTANTLY credentials. Use the returned orgId values when calling POST /exports/platform-credential or PUT /exports/platform-credential to associate a credential with a specific workspace.

GET /exports/platform-workspaces?credentialId=H8M9JV2S9HMPYFQW393AZHQVD4XM

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Query Params

Responses

🟢200Success

application/json

List of workspaces the credential has access to.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

🟠422Validation Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/exports/platform-workspaces?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM&credentialId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Fetched workspaces successfully",
    "data": [
        {
            "orgId": "org_H8M9JV2S9HMP",
            "name": "Acme Corp"
        }
    ]
}

Modified at 2026-08-20 09:38:56

Get Platform Credentials

Add Platform Credential