List companies

GET

https://api.schematichq.com/companies

GET

/companies

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.companies.listCompanies();

Try it

1 {
2   "data": [
3     {
4       "add_ons": [
5         {
6           "id": "id",
7           "name": "name"
8         }
9       ],
10       "billing_subscriptions": [
11         {
12           "cancel_at_period_end": true,
13           "created_at": "2024-01-15T09:30:00Z",
14           "currency": "currency",
15           "customer_external_id": "customer_external_id",
16           "discounts": [
17             {
18               "coupon_id": "coupon_id",
19               "coupon_name": "coupon_name",
20               "discount_external_id": "discount_external_id",
21               "duration": "duration",
22               "is_active": true,
23               "started_at": "2024-01-15T09:30:00Z",
24               "subscription_external_id": "subscription_external_id"
25             }
26           ],
27           "id": "id",
28           "interval": "interval",
29           "period_end": 1,
30           "period_start": 1,
31           "products": [
32             {
33               "created_at": "2024-01-15T09:30:00Z",
34               "currency": "currency",
35               "environment_id": "environment_id",
36               "external_id": "external_id",
37               "id": "id",
38               "interval": "interval",
39               "name": "name",
40               "price": 1,
41               "price_external_id": "price_external_id",
42               "price_id": "price_id",
43               "quantity": 1.1,
44               "subscription_id": "subscription_id",
45               "updated_at": "2024-01-15T09:30:00Z",
46               "usage_type": "usage_type"
47             }
48           ],
49           "status": "status",
50           "subscription_external_id": "subscription_external_id",
51           "total_price": 1
52         }
53       ],
54       "created_at": "2024-01-15T09:30:00Z",
55       "entity_traits": [
56         {
57           "created_at": "2024-01-15T09:30:00Z",
58           "definition_id": "definition_id",
59           "environment_id": "environment_id",
60           "id": "id",
61           "updated_at": "2024-01-15T09:30:00Z",
62           "value": "value"
63         }
64       ],
65       "environment_id": "environment_id",
66       "id": "id",
67       "keys": [
68         {
69           "created_at": "2024-01-15T09:30:00Z",
70           "definition_id": "definition_id",
71           "entity_id": "entity_id",
72           "entity_type": "entity_type",
73           "environment_id": "environment_id",
74           "id": "id",
75           "key": "key",
76           "updated_at": "2024-01-15T09:30:00Z",
77           "value": "value"
78         }
79       ],
80       "metrics": [
81         {
82           "account_id": "account_id",
83           "captured_at_max": "2024-01-15T09:30:00Z",
84           "captured_at_min": "2024-01-15T09:30:00Z",
85           "company_id": "company_id",
86           "created_at": "2024-01-15T09:30:00Z",
87           "environment_id": "environment_id",
88           "event_subtype": "event_subtype",
89           "month_reset": "month_reset",
90           "period": "period",
91           "value": 1
92         }
93       ],
94       "name": "name",
95       "payment_methods": [
96         {
97           "created_at": "2024-01-15T09:30:00Z",
98           "customer_external_id": "customer_external_id",
99           "environment_id": "environment_id",
100           "external_id": "external_id",
101           "id": "id",
102           "payment_method_type": "payment_method_type",
103           "updated_at": "2024-01-15T09:30:00Z"
104         }
105       ],
106       "plans": [
107         {
108           "id": "id",
109           "name": "name"
110         }
111       ],
112       "updated_at": "2024-01-15T09:30:00Z",
113       "user_count": 1,
114       "billing_subscription": {
115         "cancel_at_period_end": true,
116         "created_at": "2024-01-15T09:30:00Z",
117         "currency": "currency",
118         "customer_external_id": "customer_external_id",
119         "discounts": [
120           {
121             "coupon_id": "coupon_id",
122             "coupon_name": "coupon_name",
123             "discount_external_id": "discount_external_id",
124             "duration": "duration",
125             "is_active": true,
126             "started_at": "2024-01-15T09:30:00Z",
127             "subscription_external_id": "subscription_external_id"
128           }
129         ],
130         "id": "id",
131         "interval": "interval",
132         "period_end": 1,
133         "period_start": 1,
134         "products": [
135           {
136             "created_at": "2024-01-15T09:30:00Z",
137             "currency": "currency",
138             "environment_id": "environment_id",
139             "external_id": "external_id",
140             "id": "id",
141             "interval": "interval",
142             "name": "name",
143             "price": 1,
144             "price_external_id": "price_external_id",
145             "price_id": "price_id",
146             "quantity": 1.1,
147             "subscription_id": "subscription_id",
148             "updated_at": "2024-01-15T09:30:00Z",
149             "usage_type": "usage_type"
150           }
151         ],
152         "status": "status",
153         "subscription_external_id": "subscription_external_id",
154         "total_price": 1
155       },
156       "last_seen_at": "2024-01-15T09:30:00Z",
157       "logo_url": "logo_url",
158       "plan": {
159         "id": "id",
160         "name": "name"
161       },
162       "traits": {
163         "key": "value"
164       }
165     }
166   ],
167   "params": {
168     "ids": [
169       "ids"
170     ],
171     "limit": 1,
172     "offset": 1,
173     "plan_id": "plan_id",
174     "q": "q",
175     "without_feature_override_for": "without_feature_override_for",
176     "without_plan": true
177   }
178 }

Query parameters

idsstringOptional

Filter companies by multiple company IDs (starts with comp_)

plan_idstringOptional

Filter companies by plan ID (starts with plan_)

qstringOptional

Search for companies by name, keys or string traits

without_feature_override_forstringOptional

Filter out companies that already have a company override for the specified feature ID

without_planbooleanOptional

Filter out companies that have a plan

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

The returned resources

paramsobject

Input parameters

List companies

Headers

Query parameters

Response

Errors