list.mdx

title	Companies API: List
description	Reference for the list query in the Companies API.

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"

Endpoint

Property	Value
Type	query
Method	GET
Path	/api/external/v1/companies/list
Handler	OperatelyWeb.Api.Companies.List

Authentication

• Requires a valid API token.
• Read-only and full-access tokens can execute this query.

Inputs

</tbody>

Field	Type	Required	Nullable	Default
include_member_count	boolean	No	Yes	-

Outputs

Field	Type	Required	Nullable
companies	array of company object	Yes	No

cURL Example

<CurlExampleBlock client:load command={"curl --request GET \\n --url "https://app.operately.com/api/external/v1/companies/list?include_member_count=true\" \\n --header "Authorization: Bearer ${OPERATELY_API_TOKEN}""} />

Response Example

{
  "companies": [
    {
      "admins": [
        "<person>"
      ],
      "company_space_id": "value",
      "enabled_experimental_features": [
        "value"
      ],
      "general_space": "<space>",
      "id": "value",
      "member_count": 123,
      "mission": "value",
      "name": "value",
      "owners": [
        "<person>"
      ],
      "people": [
        "<person>"
      ],
      "permissions": "<company_permissions>",
      "setup_completed": true,
      "trusted_email_domains": [
        "value"
      ]
    }
  ]
}