get_company

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/get_company
Handler	OperatelyWeb.Api.Queries.GetCompany

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
id	company_id primitive (encoded as string)	No	No	-
include_permissions	boolean	No	No	-
include_people	boolean	No	No	-
include_admins	boolean	No	No	-
include_owners	boolean	No	No	-
include_general_space	boolean	No	No	-
include_members_access_levels	boolean	No	No	-

Outputs#

Field	Type	Required	Nullable
company	company object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_company?id=value&include_admins=true&include_general_space=true&include_members_access_levels=true&include_owners=true&include_people=true&include_permissions=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "company": {
    "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"
    ]
  }
}