Search

Overview

The search endpoint performs a cross-type text search across all config items in a connection. It returns a flat list of matching items from any config type, making it useful for finding objects by name without knowing which type they belong to.

Request

GET /v1/connections/:connectionId/search?q=:query

The q query parameter is required and accepts up to 200 characters.

Example request

curl "https://api.configly.app/v1/connections/YOUR_CONNECTION_ID/search?q=auto-close" \
  -H "Authorization: Bearer cly_your_key"

Response

Results are returned as a flat list. Each item includes its configType so you can identify which category it belongs to.

{
  "data": [
    {
      "id": 12345,
      "name": "Auto-close solved tickets",
      "configType": "triggers",
      "snippet": "Auto-close solved tickets after 48 hours"
    },
    {
      "id": 67890,
      "name": "Auto-close pending tickets",
      "configType": "automations"
    }
  ],
  "meta": {
    "query": "auto-close",
    "total": 2
  }
}

Error codes