Group By Account

GET

1 curl -G https://app.termina.ai/api/v1/group \
2      -H "Authorization: Bearer <token>" \
3      -d account=account

Play

200Retrieved

1 {
2   "name": "name",
3   "account": "example.com",
4   "id": 1,
5   "thumbnail_url": "thumbnail_url",
6   "analysis_email": "analysis_email",
7   "data_api_access": true,
8   "created_at": "2024-01-15T09:30:00Z",
9   "updated_at": "2024-01-15T09:30:00Z",
10   "is_archived": true,
11   "account_manager": {
12     "name": "name",
13     "email": "email",
14     "thumbnail": "thumbnail"
15   },
16   "user_count": 1,
17   "deal_count": 1,
18   "users": [
19     {
20       "name": "name",
21       "email": "email",
22       "id": 1,
23       "roles": [
24         {
25           "id": 1,
26           "name": "name"
27         }
28       ],
29       "thumbnail": "thumbnail",
30       "created_at": "2024-01-15T09:30:00Z",
31       "updated_at": "2024-01-15T09:30:00Z",
32       "is_archived": true
33     }
34   ]
35 }

Lookup a group by its account.

Query parameters

accountstringRequired

sort_bystringOptional

sort_orderstringOptional

pageintegerOptional

page_sizeintegerOptional

Response

Successful Response

namestring

The name of the group

accountstring

The account of the group. Must be a valid domain, URL, or email. The account will be normalized to a canonical form.

idinteger

thumbnail_urlstringOptional

The thumbnail URL of the group

analysis_emailstringOptional

The email address for analysis to be sent to

data_api_accessbooleanOptional

Whether the group has access to the data API

created_atdatetimeOptional

updated_atdatetimeOptional

is_archivedbooleanOptional

account_managerobjectOptional

user_countintegerOptional

deal_countintegerOptional

userslist of objectsOptional

Group By Account

Headers

Query parameters

Response

Errors