Companies API: Quick search

Endpoint#

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

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
query	string	Yes	No	-

Outputs#

Field	Type	Required	Nullable
spaces	array of space object	Yes	No
projects	array of project object	Yes	No
goals	array of goal object	Yes	No
milestones	array of milestone object	Yes	No
tasks	array of task object	Yes	No
people	array of person object	Yes	No
discussions	array of quick_search_discussion object	Yes	No
folders	array of quick_search_resource object	Yes	No
documents	array of quick_search_resource object	Yes	No
files	array of quick_search_resource object	Yes	No
links	array of quick_search_resource object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/companies/quick_search?query=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "discussions": [
    {
      "context": "value",
      "id": "value",
      "title": "value",
      "url": "value"
    }
  ],
  "documents": [
    {
      "context": "value",
      "id": "value",
      "name": "value",
      "url": "value"
    }
  ],
  "files": [
    {
      "context": "value",
      "id": "value",
      "name": "value",
      "url": "value"
    }
  ],
  "folders": [
    {
      "context": "value",
      "id": "value",
      "name": "value",
      "url": "value"
    }
  ],
  "goals": [
    {
      "__typename": "value",
      "access_levels": "<access_levels>",
      "archived_at": "2026-01-01",
      "champion": "<person>",
      "checklist": [
        "<goal_check>"
      ],
      "closed_at": "2026-01-01",
      "closed_by": "<person>",
      "description": "value",
      "id": "value",
      "inserted_at": "2026-01-01",
      "is_archived": true,
      "is_closed": true,
      "is_outdated": true,
      "last_check_in": "<goal_progress_update>",
      "last_check_in_id": "value",
      "my_role": "value",
      "name": "value",
      "next_update_scheduled_at": "2026-01-01",
      "notifications": [
        "<notification>"
      ],
      "parent_goal": "<goal>",
      "parent_goal_id": "value",
      "permissions": "<goal_permissions>",
      "potential_subscribers": [
        "<subscriber>"
      ],
      "privacy": "public",
      "progress_percentage": 12.34,
      "projects": [
        "<project>"
      ],
      "resource_hub": "<resource_hub>",
      "retrospective": "<goal_retrospective>",
      "reviewer": "<person>",
      "space": "<space>",
      "status": "on_track",
      "success": true,
      "targets": [
        "<target>"
      ],
      "timeframe": "<timeframe>",
      "updated_at": "2026-01-01",
      "url": "value"
    }
  ],
  "links": [
    {
      "context": "value",
      "id": "value",
      "name": "value",
      "url": "value"
    }
  ],
  "milestones": [
    {
      "__typename": "value",
      "available_statuses": [
        "<task_status>"
      ],
      "comments": [
        "<milestone_comment>"
      ],
      "comments_count": 123,
      "completed_at": "2026-01-01",
      "creator": "<person>",
      "description": "value",
      "id": "value",
      "inserted_at": "2026-01-01",
      "permissions": "<project_permissions>",
      "project": "<project>",
      "space": "<space>",
      "status": "pending",
      "subscription_list": "<subscription_list>",
      "tasks_kanban_state": "value",
      "tasks_ordering_state": [
        "value"
      ],
      "timeframe": "<timeframe>",
      "title": "value",
      "url": "value"
    }
  ],
  "people": [
    {
      "__typename": "value",
      "access_level": "<access_options_int>",
      "avatar_blob_id": "value",
      "avatar_url": "value",
      "company": "<company>",
      "daily_summary_delivery_time": "value",
      "description": "value",
      "dismissed_product_release_id": "value",
      "email": "value",
      "email_preference": "buffered",
      "email_window_minutes": "<email_window_minutes>",
      "full_name": "value",
      "has_open_invitation": true,
      "id": "value",
      "invite_link": "<invite_link>",
      "language": "en",
      "manager": "<person>",
      "notify_about_assignments": true,
      "notify_on_mention": true,
      "peers": [
        "<person>"
      ],
      "permissions": "<person_permissions>",
      "reports": [
        "<person>"
      ],
      "send_daily_summary": true,
      "show_dev_bar": true,
      "suspended": true,
      "time_format": "automatic",
      "timezone": "value",
      "title": "value",
      "type": "value",
      "url": "value"
    }
  ],
  "projects": [
    {
      "__typename": "value",
      "access_levels": "<access_levels>",
      "archived_at": "2026-01-01",
      "champion": "<person>",
      "closed_at": "2026-01-01",
      "contributors": [
        "<project_contributor>"
      ],
      "description": "value",
      "goal": "<goal>",
      "goal_id": "value",
      "id": "value",
      "inserted_at": "2026-01-01",
      "is_archived": true,
      "is_outdated": true,
      "is_pinned": true,
      "last_check_in": "<project_check_in>",
      "milestones": [
        "<milestone>"
      ],
      "milestones_ordering_state": [
        "value"
      ],
      "my_role": "value",
      "name": "value",
      "next_check_in_scheduled_at": "2026-01-01",
      "next_milestone": "<milestone>",
      "next_update_scheduled_at": "2026-01-01",
      "notifications": [
        "<notification>"
      ],
      "permissions": "<project_permissions>",
      "potential_subscribers": [
        "<subscriber>"
      ],
      "privacy": "value",
      "resource_hub": "<resource_hub>",
      "retrospective": "<project_retrospective>",
      "reviewer": "<person>",
      "space": "<space>",
      "space_id": "value",
      "state": "active",
      "status": "value",
      "subscription_list": "<subscription_list>",
      "success_status": "achieved",
      "task_statuses": [
        "<task_status>"
      ],
      "tasks_kanban_state": "value",
      "tasks_view": "list",
      "timeframe": "<timeframe>",
      "updated_at": "2026-01-01",
      "url": "value"
    }
  ],
  "spaces": [
    {
      "__typename": "value",
      "access_levels": "<access_levels>",
      "color": "value",
      "icon": "value",
      "id": "value",
      "is_company_space": true,
      "is_member": true,
      "members": [
        "<person>"
      ],
      "mission": "value",
      "name": "value",
      "notifications": [
        "<notification>"
      ],
      "permissions": "<space_permissions>",
      "potential_subscribers": [
        "<subscriber>"
      ],
      "private_space": true,
      "task_statuses": [
        "<task_status>"
      ],
      "tasks_kanban_state": "value",
      "url": "value"
    }
  ],
  "tasks": [
    {
      "__typename": "value",
      "assignees": [
        "<person>"
      ],
      "available_statuses": [
        "<task_status>"
      ],
      "closed_at": "2026-01-01T09:30:00Z",
      "comments_count": 123,
      "creator": "<person>",
      "description": "value",
      "due_date": "<contextual_date>",
      "id": "value",
      "inserted_at": "2026-01-01",
      "milestone": "<milestone>",
      "name": "value",
      "permissions": "<project_permissions>",
      "priority": "value",
      "project": "<project>",
      "project_space": "<space>",
      "reminders": [
        "<task_reminder>"
      ],
      "size": "value",
      "space": "<space>",
      "status": "<task_status>",
      "subscription_list": "<subscription_list>",
      "type": "space",
      "updated_at": "2026-01-01",
      "url": "value"
    }
  ]
}