List companies

GET

Query parameters

idsstringOptional

plan_idstringOptional

qstringOptional

Search filter

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

This endpoint returns an object

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

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