HTTP Verb: GET

Available statuses: 200 OK, 204 No Content

Object: Mention

Location: n/a

Formats: XML, JSON

Returns user mentions, by default all mentions will be returned.

Params

Param Description
read Return the list of read mentions
unread Return the list of unread mentions.

Examples

Request JSON, using cURL utility:

curl -i -H "Authorization: Bearer _token" https://api.assembla.com/v1/user/mentions.json

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 13 Oct 2014 12:26:09 GMT
Etag: "3885dd6136eda6a9d77b693ff46cc4ec"
Server: nginx/1.2.1
Status: 200 OK
Transfer-Encoding: chunked
...

[
  {
    "id":19266294,
    "author_id":"aIING2b5Sr4QIXacwqjQWU",
    "link":"https://.assembla.com/spaces/test/tickets/111",
    "message":"/cc @Operations ",
    "read":true,
    "created_at":"2014-08-13T23:39:18+05:30"
  }
  ...
]

JSON is formatted here for readability, in a real response JSON body is inline with no indentation.

Request XML, using cURL utility:

curl -i -H "Authorization: Bearer _token" https://api.assembla.com/v1/user/mentions.xml

Response

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
Date: Mon, 13 Oct 2014 12:26:09 GMT
Etag: "3885dd6136eda6a9d77b693ff46cc4ec"
Server: nginx/1.2.1
Status: 200 OK
Transfer-Encoding: chunked
...

<?xml version="1.0" encoding="UTF-8"?>
<mentions type="array">
  <mention>
    <id type="integer">19266294</id>
    <author-id>aIING2b5Sr4QIXacwqjQWU</author-id>
    <link>https://assembla.com/spaces/test/tickets/111</link>
    <message>/cc @Operations </message>
    <read type="boolean">true</read>
    <created-at type="datetime">2014-08-13T18:09:18Z</created-at>
  </mention>
  ...
</mentions>

Description for each field: mention object fields reference