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_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

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           "currency": "currency",
13           "external_id": "external_id",
14           "id": "id",
15           "interval": "interval",
16           "total_price": 1,
17           "updated_at": "2024-01-15T09:30:00Z"
18         }
19       ],
20       "created_at": "2024-01-15T09:30:00Z",
21       "entity_traits": [
22         {
23           "created_at": "2024-01-15T09:30:00Z",
24           "definition_id": "definition_id",
25           "environment_id": "environment_id",
26           "id": "id",
27           "updated_at": "2024-01-15T09:30:00Z",
28           "value": "value"
29         }
30       ],
31       "environment_id": "environment_id",
32       "id": "id",
33       "keys": [
34         {
35           "created_at": "2024-01-15T09:30:00Z",
36           "definition_id": "definition_id",
37           "entity_id": "entity_id",
38           "entity_type": "entity_type",
39           "environment_id": "environment_id",
40           "id": "id",
41           "key": "key",
42           "updated_at": "2024-01-15T09:30:00Z",
43           "value": "value"
44         }
45       ],
46       "name": "name",
47       "plans": [
48         {
49           "id": "id",
50           "name": "name"
51         }
52       ],
53       "updated_at": "2024-01-15T09:30:00Z",
54       "user_count": 1,
55       "last_seen_at": "2024-01-15T09:30:00Z",
56       "logo_url": "logo_url",
57       "plan": {
58         "id": "id",
59         "name": "name"
60       },
61       "traits": {
62         "key": "value"
63       }
64     }
65   ],
66   "params": {
67     "ids": [
68       "ids"
69     ],
70     "limit": 1,
71     "offset": 1,
72     "plan_id": "plan_id",
73     "q": "q",
74     "without_feature_override_for": "without_feature_override_for",
75     "without_plan": true
76   }
77 }

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	"currency": "currency",
13	"external_id": "external_id",
14	"id": "id",
15	"interval": "interval",
16	"total_price": 1,
17	"updated_at": "2024-01-15T09:30:00Z"
18	}
19	],
20	"created_at": "2024-01-15T09:30:00Z",
21	"entity_traits": [
22	{
23	"created_at": "2024-01-15T09:30:00Z",
24	"definition_id": "definition_id",
25	"environment_id": "environment_id",
26	"id": "id",
27	"updated_at": "2024-01-15T09:30:00Z",
28	"value": "value"
29	}
30	],
31	"environment_id": "environment_id",
32	"id": "id",
33	"keys": [
34	{
35	"created_at": "2024-01-15T09:30:00Z",
36	"definition_id": "definition_id",
37	"entity_id": "entity_id",
38	"entity_type": "entity_type",
39	"environment_id": "environment_id",
40	"id": "id",
41	"key": "key",
42	"updated_at": "2024-01-15T09:30:00Z",
43	"value": "value"
44	}
45	],
46	"name": "name",
47	"plans": [
48	{
49	"id": "id",
50	"name": "name"
51	}
52	],
53	"updated_at": "2024-01-15T09:30:00Z",
54	"user_count": 1,
55	"last_seen_at": "2024-01-15T09:30:00Z",
56	"logo_url": "logo_url",
57	"plan": {
58	"id": "id",
59	"name": "name"
60	},
61	"traits": {
62	"key": "value"
63	}
64	}
65	],
66	"params": {
67	"ids": [
68	"ids"
69	],
70	"limit": 1,
71	"offset": 1,
72	"plan_id": "plan_id",
73	"q": "q",
74	"without_feature_override_for": "without_feature_override_for",
75	"without_plan": true
76	}
77	}