List companies

GET

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_planbooleanOptionalDefaults to false

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

GET

1 curl https://api.schematichq.com/companies \
2      -H "X-Schematic-Api-Key: <apiKey>"

200Retrieved

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

Built with

1	curl https://api.schematichq.com/companies \
2	-H "X-Schematic-Api-Key: <apiKey>"

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