1. API
  2. v1
  3. OTHER
  4. GENERAL

Autocomplete




Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Emails

RESOURCE FIELDS

Name Type Read-only Description
identity Email
parent Resource

Lookup emails

GET /api/v1/autocomplete/emails.json

Information

Allowed for Collaborators, Agents, Admins & Owners

Arguments

Name Type Mandatory Description
address string
exclude[] array Emails to exclude

Response

    {
        "status": 200,
        "data": [
            {
    "identity": {
    "id": 1,

    "resource_type": "identity_email"

},
    "parent": 



{
    "id": 1,

    "resource_type": "user"

}

}

        ],
        "resource": "autocomplete_email",
        "total_count": 1
    }

Tags

RESOURCE FIELDS

Name Type Read-only Description
tags string

Lookup tags

GET /api/v1/autocomplete/tags.json

Information

Allowed for Collaborators, Agents, Admins & Owners

Arguments

Name Type Mandatory Description
name string
exclude[] array Tags to exclude

Response

{
    "status": 200,
    "data": [
        {
            "id": 3,
            "name": "maintenance",
            "resource_type": "tags"
        }
    ],
    "resource": "tags",
    "total_count": 1
}

Organizations

RESOURCE FIELDS

Name Type Read-only Description
organization Organization

Lookup organizations

GET /api/v1/autocomplete/organizations.json

Information

Allowed for Collaborators, Agents, Admins & Owners

Arguments

Name Type Mandatory Description
name string
exclude[] array Organizations to exclude

Response

    {
        "status": 200,
        "data": [
            {
    "id": 1,

    "resource_type": "organization"

}

        ],
        "resource": "organization",
        "total_count": 1
    }

Users

RESOURCE FIELDS

Name Type Read-only Description
user User

Lookup users

GET /api/v1/autocomplete/users.json

Information

Allowed for Collaborators, Agents, Admins & Owners

Arguments

Name Type Mandatory Description
name string
in string ADMINS, AGENTS, COLLABORATORS, CUSTOMERS
Multiple comma separated values are accepted
exclude[] array Users to exclude

Response

    {
        "status": 200,
        "data": [




{
    "id": 1,

    "uuid": "11b60c25-c44c-47b8-9f48-56631cd7fa01",
    "full_name": "Simon Blackhouse",
    "legacy_id": null,
    "designation": "Community Manager",
    "is_enabled": true,
    "is_mfa_enabled": true,
    "role":







{
    "id": 2,

    "resource_type": "role"

},

    "avatar": "https://brewfictus.kayako.com/avatar/get/24ee2d81-ad95-5ae1-a07e-7ccedcdb70b8",
    "agent_case_access": "ALL",
    "organization_case_access": null,
    "organization": {
    "id": 1,

    "resource_type": "organization"

}
,
    "teams": [

    ],
    "emails": [
        {
    "id": 1,

    "resource_type": "identity_email"

}
    ],
    "phones": [




{
    "id": 1,

    "resource_type": "identity_phone"

}

    ],
    "twitter": [],
    "facebook": [],
    "external_identifiers": [],
    "addresses": [
        {
    "id": 1,

    "resource_type": "contact_address"

}

    ],
    "websites": [
        {
    "id": 1,

    "resource_type": "contact_website"

}
    ],
   "custom_fields": [
       {
           "field": {
    "id": 1,

    "resource_type": "user_field"

}
,
           "value": "Customer Success",
           "resource_type": "user_field_value"
       }
    ],
    "pinned_notes_count": 0,
    "locale": "en-us",
    "time_zone": null,
    "time_zone_offset": null,
    "greeting": null,
    "signature": null,
    "status_message": null,
    "last_seen_user_agent": null,
    "last_seen_ip": null,
    "last_seen_at": null,
    "last_active_at": null,
    "realtime_channel": "presence-0c1c9535b26b749f815a22cb459a4a8084be77b6ac9515751ef5a743b190bef3@v1_users_6",
    "presence_channel": "user_presence-281f395f6f51d031a6d3db3489906c98285191ebac41bb744f9323f61af63433@5c98cdaa58dd91ff1119a476e8b3e305d2906d3b",
    "password_updated_at": "2016-03-15T10:38:01+05:00",
    "avatar_updated_at": null,
    "last_logged_in_at": null,
    "last_activity_at": null,
    "created_at": "2016-03-15T10:38:01+05:00",
    "updated_at": "2016-03-15T10:38:01+05:00",




    "resource_type": "user"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/users/1"

}

        ],
        "resource": "user",
        "total_count": 1
    }