Search Deals

GET

https://app.termina.ai/api/v1/group/:group_id/deal/search

GET

/api/v1/group/:group_id/deal/search

1 import { TerminaClient } from "termina";
2 
3 const client = new TerminaClient({ token: "YOUR_TOKEN" });
4 await client.deal.search(1);

Try it

1 {
2   "total_count": 1,
3   "page": 1,
4   "page_size": 1,
5   "data": [
6     {
7       "round_name": "round_name",
8       "id": 1,
9       "company": {
10         "name": "name",
11         "domain": "example.com",
12         "id": 1,
13         "group_id": 1
14       },
15       "notes": "notes",
16       "priority": "low",
17       "round_amount": 1,
18       "round_target": 1,
19       "tags": [
20         "tags"
21       ],
22       "company_summary": "company_summary",
23       "created_at": "2024-01-15T09:30:00Z",
24       "updated_at": "2024-01-15T09:30:00Z",
25       "is_archived": true,
26       "files": [
27         {
28           "name": "name",
29           "id": 1
30         }
31       ],
32       "data": {
33         "financials_exist": true,
34         "talent_exists": true,
35         "product_metrics": [
36           {
37             "user_type": "consumer",
38             "metric": "revenue"
39           }
40         ],
41         "unit_economics_metrics": [
42           {
43             "user_type": "consumer"
44           }
45         ],
46         "benchmarks_user_types": [
47           "consumer"
48         ],
49         "benchmark_categories": [
50           "saas",
51           "fintech"
52         ]
53       },
54       "status": "on deck"
55     }
56   ]
57 }

Search deals within a group.

Path parameters

group_idintegerRequired

Query parameters

round_namestringOptional

notesstringOptional

tagsstringOptional

company_namestringOptional

company_domainstringOptional

ignore_archivedbooleanOptionalDefaults to true

sort_bystringOptional

sort_orderstringOptionalformat: "^(asc|desc)$"Defaults to asc

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional>=1Defaults to 100

Response

Successful Response

total_countinteger

pageinteger

page_sizeinteger

datalist of objects

Search Deals

Path parameters

Headers

Query parameters

Response

Errors