API Reference version 2

Get all emoticons

GET/v2/emoticon

Gets all emoticons for the current group

Query parameters

Type Parameter Description Required?
integer start-index

The start index for the result set

Defaults to 0.

integer max-results

The maximum number of results.

Valid length range: 0 - 1000.

Defaults to 100.

string type

The type of emoticons to get

Valid values: global, group, all.

Defaults to 'all'.

200 application/json
Type Property Description Required?
array items

An array of the following objects.

Required
string url

The URL to the emoticon image file

Required
object links

URLs to retrieve emoticon information

Required
string self

The URL to use to retrieve the full emoticon information

Required
string id

ID of the emoticon.

Required
string shortcut

The shortcut text to use to invoke this emoticon in chat

Required
integer startIndex

The start index for this set of results.

Required
integer maxResults

The maximum number of results returned.

Valid length range: 1 - 1000.

Required
object links

An object with the following properties.

Required
string self

The URL for this resource.

Required
string prev

The URL to retrieve the previous set of results.

string next

The URL to retrieve the next page of results.