User Search

Endpoints:

Scope: none

Retrieve a list of users filtered by the given criteria.

Query Parameters

Name Description
q REQUIRED List of words included in user profiles or names
order One of id or relevance. Default is by relevance
locale An ISO formatted locale; e.g., en_US
timezone Timezone in tzinfo format
types Comma-separated list of user types of: human, feed, bot
Example
curl "https://api.pnut.io/v0/users/search?q=news&types=feed" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "X-Pretty-Json: 1"

Returns a list of users

{
    "meta": {
        "more": false,
        "max_id": "0",
        "min_id": "0",
        "code": 200
    },
    "data": [
        {"...User Object..."},
        {"...User Object..."}
    ]
}