get_autocompletes

v1.0.0

Retrieve an array of names and locations, filtered by category, that begin with the query string passed in. Ideally used for search autocomplete dropdowns, as the search functionality filters against name and location. The four potential categories are: conversations for names of users you are in existing conversations with; matches for names of users you have previously skipped over; people for names of all other users; locations for locations of users. Only users and their locations who exist with the current access token's bubble are considered.

Input

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "conversations": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "locations": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "matches": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "people": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}