aWhere Manual
DevelopAPIcore-services

Platform

What a site tells before anyone signs in: its Release, its Apps, its settings, the public names of clients and keys, and pictures.

GET
/api

Response Body

The answer, as JSON.

curl -X GET "https://platform.example.com/api"
Empty
GET
/api/activity/admin

Authorization

headerAuthorizationBearer <token>

An access token of an OAuth client: Authorization: Bearer <token>.

Response Body

The answer, as JSON.

curl -X GET "https://platform.example.com/api/activity/admin" \  -H "Authorization: Bearer $TOKEN"
Empty
GET
/api/activity/drive

Authorization

headerAuthorizationBearer <token>

An access token of an OAuth client: Authorization: Bearer <token>.

Response Body

The answer, as JSON.

curl -X GET "https://platform.example.com/api/activity/drive" \  -H "Authorization: Bearer $TOKEN"
Empty
GET
/api/activity/group

Authorization

headerAuthorizationBearer <token>

An access token of an OAuth client: Authorization: Bearer <token>.

Response Body

The answer, as JSON.

curl -X GET "https://platform.example.com/api/activity/group" \  -H "Authorization: Bearer $TOKEN"
Empty
GET
/api/activity/item

Authorization

headerAuthorizationBearer <token>

An access token of an OAuth client: Authorization: Bearer <token>.

Response Body

The answer, as JSON.

curl -X GET "https://platform.example.com/api/activity/item" \  -H "Authorization: Bearer $TOKEN"
Empty
GET
/api/activity/user

Authorization

headerAuthorizationBearer <token>

An access token of an OAuth client: Authorization: Bearer <token>.

Response Body

The answer, as JSON.

curl -X GET "https://platform.example.com/api/activity/user" \  -H "Authorization: Bearer $TOKEN"
Empty
GET
/api/auth

Authorization

headerAuthorizationBearer <token>

An access token of an OAuth client: Authorization: Bearer <token>.

Response Body

The answer, as JSON.

curl -X GET "https://platform.example.com/api/auth" \  -H "Authorization: Bearer $TOKEN"
Empty
GET
/api/configuration

Response Body

The answer.

curl -X GET "https://platform.example.com/api/configuration"
Empty
GET
/api/credential/api-key/{id}

Path Parameters

id*string

The id.

Response Body

The answer.

curl -X GET "https://platform.example.com/api/credential/api-key/$ID"
Empty
GET
/api/credential/client/{id}

Path Parameters

id*string

The id.

Response Body

The answer.

curl -X GET "https://platform.example.com/api/credential/client/$ID"
Empty
GET
/api/credential/scope

Response Body

The answer.

application/json
  1. response
[index: integer]?unknown
curl -X GET "https://platform.example.com/api/credential/scope"
[  null]
GET
/api/image/client/{id}

Path Parameters

id*string

The id.

Query Parameters

select?string

The fields to return, as a JSON object of field names to 1 or 0.

Response Body

The bytes.

response?fileapplication/octet-stream
Formatbinary
curl -X GET "https://platform.example.com/api/image/client/$ID"
"string"

Send a profile picture

GET
/api/image/profile/{id}

Path Parameters

id*string

The id.

Query Parameters

select?string

The fields to return, as a JSON object of field names to 1 or 0.

Response Body

The bytes.

response?fileapplication/octet-stream
Formatbinary
curl -X GET "https://platform.example.com/api/image/profile/$ID"
"string"
GET
/api/platform

Response Body

The site.

application/json
  1. response
data?array<>

The installed Apps, core Apps first.

apps?array<>

The same list as data.

release?

The Release of the platform: its version and commit.

manual?
curl -X GET "https://platform.example.com/api/platform"
{  "data": [    {}  ],  "apps": [    {}  ],  "release": {},  "manual": {    "url": "string"  }}