Skip to main content

Get All Snippets

This endpoint retrieves all snippets.

info

This operation requires authentication.

HTTP Request

GET /api/v2/pm/

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalseNumber of results to return per page.
offsetqueryintegerfalseThe initial index from which to return the results.

Example Request


const headers = {
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/pm/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
200OKnoneInline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» countintegerfalsenoneTotal results count
» nextstring(uri)¦nullfalsenoneNext page url
» previousstring(uri)¦nullfalsenonePrevious page url
» resultslist(Private Message Snippet)falsenoneList of results

Example responses

{
"count": 123,
"next": "string(uri)",
"previous": "string(uri)",
"results": [
{
"id": 0,
"headline": "string",
"sender": "object",
"receiver": "object",
"created_at": "2019-08-24T14:15:22Z",
"last_message_at": "2019-08-24T14:15:22Z",
"thread_status": "string"
},
{
"id": 0,
"headline": "string",
"sender": "object",
"receiver": "object",
"created_at": "2019-08-24T14:15:22Z",
"last_message_at": "2019-08-24T14:15:22Z",
"thread_status": "string"
}
]
}