Perform autocomplete search

GET 
/autocomplete

Perform autocomplete search

Request

Query Parameters

q stringrequired

The autocomplete query

Header Parameters

X-SaleCycle-Id stringrequired

Your SaleCycle API Subscription key

Responses

200

Successful operation

application/json

Schema

Schema

data object[]required
Array [
completed stringrequired
The portion of the text that has been auto-completed
highlighted stringrequired
The full result, with highlighting of the completion
]

Example (from schema)

{
  "data": [
    {
      "completed": "string",
      "highlighted": "t-s<strong>hirt</strong>"
    }
  ]
}

400

Validation Error

application/json

Schema

Schema

errors object[]required
Array [
status stringrequired
title stringrequired
detail stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

Loading...