Clients
Manage a team's clients — the customers or brands you report on — and the accounts linked to each.
A client groups the connector accounts you use to report on a single customer or brand. Endpoints under /teams/{teamId}/clients are team-scoped — they act on a specific team identified by the teamId path parameter, and access is governed by your role in that team.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /teams/{teamId}/clients | List a team's clients |
GET | /teams/{teamId}/clients/{clientId} | Get a single client |
GET | /teams/{teamId}/clients/{clientId}/accounts | List a client's linked accounts |
GET | /teams/{teamId}/clients/{clientId}/accounts/{connectorId} | List a client's accounts for one connector |
POST | /teams/{teamId}/clients/{clientId}/accounts/{connectorId}/{accountId} | Link an account to a client |
DELETE | /teams/{teamId}/clients/{clientId}/accounts/{connectorId}/{accountId} | Unlink an account from a client |
The client object
{
"id": "0190f8c0-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
"name": "Acme Corp",
"domain": "acme.com",
"status": "active",
"metadata": {
"logoUrl": "https://assets.gox.ai/tmr/logos/acme.png",
"brandColor": "#0A66C2"
},
"link": "https://hub.twominutereports.com/clients/0190f8c0-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
"createdAt": "2026-01-12T08:15:00.000Z",
"updatedAt": "2026-05-20T11:42:00.000Z",
"createdBy": "0190f8a1-2b3c-7d4e-8f90-1a2b3c4d5e6f"
}
id
string · uuid v7
Client identifier. Use it as
clientId in the other client endpoints.name
string
The client's display name.
domain
string | null
The client's website domain, or
null if not set.status
string
The client's status. Defaults to
active.metadata
object
Free-form metadata. Common keys are
logoUrl and brandColor (both string | null); additional keys may be present.link
string · url
A link to the client in the Two Minute Reports hub.
createdAt
string
When the client was created.
updatedAt
string | null
When the client was last updated, or
null if it has never been updated.createdBy
string · uuid v7 | null
The ID of the user who created the client, or
null if unknown.