GET
/
companies
curl --request GET \
  --url https://api.schematichq.com/companies \
  --header 'X-Schematic-Api-Key: <api-key>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "entity_traits": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "definition": {
            "created_at": "2023-11-07T05:31:56Z",
            "display_name": "<string>",
            "entity_type": "<string>",
            "hierarchy": [
              "<string>"
            ],
            "id": "<string>",
            "trait_type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "definition_id": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "value": "<string>"
        }
      ],
      "environment_id": "<string>",
      "id": "<string>",
      "keys": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "definition": {
            "created_at": "2023-11-07T05:31:56Z",
            "entity_type": "<string>",
            "id": "<string>",
            "key": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "definition_id": "<string>",
          "entity_id": "<string>",
          "entity_type": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "key": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "value": "<string>"
        }
      ],
      "last_seen_at": "2023-11-07T05:31:56Z",
      "logo_url": "<string>",
      "name": "<string>",
      "plans": [
        {
          "id": "<string>",
          "image_url": "<string>",
          "name": "<string>"
        }
      ],
      "traits": {},
      "updated_at": "2023-11-07T05:31:56Z",
      "user_count": 123
    }
  ],
  "params": {
    "ids": [
      "<string>"
    ],
    "limit": "100",
    "offset": "0",
    "plan_id": "<string>",
    "q": "<string>",
    "without_feature_override_for": "<string>"
  }
}

Authorizations

X-Schematic-Api-Key
string
headerrequired

Query Parameters

ids
string[]
plan_id
string
q
string

Search filter

without_feature_override_for
string

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

limit
integer

Page limit (default 100)

offset
integer

Page offset (default 0)

Response

200 - application/json
data
object[]
required

The returned resources

params
object
required

Input parameters