Clients

Client name can contain any Unicode characters. Be sure to escape it if necessary.

Endpoints:

GET /users/{user_id}/clients

Scope: any

Retrieve a list of active clients created by a user.

URL Parameters

Name Description
user_id ID of the user to list clients from
Example Call
curl "https://api.pnut.io/v0/users/8/clients" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "X-Pretty-Json: 1"

Returns a list of clients

{
    "meta": {
        "code": 200
    },
    "data": [
        {
            "id": "String",
            "link": "https://example.com",
            "name": "String"
        }
    ]
}

GET /clients/{client_id}

Scope: any

Retrieve details on a public client, by client ID.

URL Parameters

Name Description
client_id ID of the client to retrieve
Example
curl "https://api.pnut.io/v0/clients/3PFPMSet53RutGINA8e5HWqYg_UCDHad" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "X-Pretty-Json: 1"

Returns the detailed client object

{
    "meta": {
        "code": 200
    },
    "data": {
        "created_at": "ISO-8601",
        "created_by": {"...User Object..."},
        "id": "String",
        "link": "https://example.com",
        "name": "String",
        "posts": 0,
        "content": {
            "text": "String",
            "html": "<span itemscope=\"https://pnut.io/schemas/Post\">String</span>",
            "entities": {
                "links": [],
                "mentions": [],
                "tags": []
            }
        }
    }
}