All users

This endpoint returns all indexed users of a business.

Endpoint

GET

https://api.thepeer.co/users

Optional query parameters

KeyData typeDescription
pageintPage number to return
perPageintAmount of records to return per page

Sample response

{
    "indexed_users": {
        "data": [
            {
                "name": "Trojan Okoh",
                "identifier": "trojan",
                "identifier_type": "username",
                "email": "trojan@thepeer.co",
                "reference": "the-nothing-the-ghost"
            },
            {
                "name": "Chike Ononye",
                "identifier": "chike",
                "identifier_type": "username",
                "email": "chike@thepeer.co",
                "reference": "design-wise-design-god"
            },
            {
                "name": "Kamsi Oleka",
                "identifier": "kamsi",
                "identifier_type": "username",
                "email": "kamsy@thepeer.co",
                "reference": "the-real-eze-mmuo"
            }
        ],
        "meta": {
            "page": 1,
            "total": 3,
            "pageCount": 1,
            "perPage": 15
        }
    }
}