The Members Autocomplete API provides a list of Members (from a specific company) filtered by a query. It is intended for fast-feedback as-you-type scenarios.

When autocompleting Members, the response will contain an array of Members that match the query across the start of firstname, lastname or email. Members are filtered by their CompanyIds of which must contain the CompanyId of the request. Actor is an abbreviated Member resource.

Autocomplete results are also dependent on whether the requestor is an internal or external member of the company. If the requestor is an external member then they will receive no autocomplete results. If the requestor was internal, then the autocomplete results should contain all the members (internal or external) of the company.

GET /members/companies/{companyId}/autocomplete?q=isi&hits=10
Accept: application/vnd.huddle.data+xml (or+json)
Authorization: OAuth2 frootymcnooty/vonbootycherooty

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+xml

<memberAutocomplete>
    <link rel="self" href="..." />
    <members>
        <actor rel="member" name="Isidore McHohenheim" email="[email protected]">
            <link rel="avatar" href="..." type="image/jpg" />
            <identity email="[email protected]" />
        </actor>
    </members>
</memberAutocomplete>

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+json

{
  "links": [
    { "rel": "self", "href": "..." }
  ],
  "members": [{
    "links": [
        { "rel": "avatar", "href" : "...", "type" : "..." }
    ],
    "name": "Isidore McHohenheim",
    "email": "[email protected]",
    "rel": "member",
    "identity": {
        "email": "[email protected]"
    }
  }]
}

Note: Unlike elsewhere in the API, the Actor links do not currently include self or alternate links.