List Profiles
A profile is a named group of social accounts — typically one brand or project. Each account belongs to at most one profile. Queues and contacts are scoped to a profile.
The first profile you create in a workspace is the default. Setting a new default clears the previous one.
The profile object
{
"id": "pro_9aB8cD7eF6gH5iJ4kL3mN2oP1q",
"name": "Acme",
"description": "Acme Inc. brand",
"color": "#4f46e5",
"default": true,
"created_at": "2026-07-12T10:00:00.000Z",
"updated_at": "2026-07-12T10:00:00.000Z"
}
GET
/v1/profiles{ "profiles": [ { "id": "pro_...", "name": "Acme", "default": true, "...": "..." } ] } Create Profile
POST
/v1/profilesBody parameters
| Field | Type | Notes |
|---|---|---|
name | string | Required |
description | string | Optional |
color | string | Optional hex color |
default | boolean | Optional; the first profile is always default |
{ "profile": { "id": "pro_...", "name": "Acme", "default": true, "...": "..." } } Get Profile
GET
/v1/profiles/:id{ "profile": { "id": "pro_...", "name": "Acme", "default": true, "...": "..." } } Update Profile
PATCH
/v1/profiles/:idUpdate any of name, description, color, default. Setting default: true makes this the workspace default.
{
"profile": {
"id": "pro_9aB8cD7eF6gH5iJ4kL3mN2oP1q",
"name": "Acme",
"description": "Acme Inc. brand",
"color": "#4f46e5",
"default": true,
"created_at": "2026-07-12T10:00:00.000Z",
"updated_at": "2026-07-12T10:00:00.000Z"
}
} Delete Profile
DELETE
/v1/profiles/:idAccounts assigned to the profile are not disconnected; their profile_id is cleared.
{ "ok": true }