All Users

All Users

This endpoint returns all your indexed users. 👨🏾‍🏫

Endpoint Get

https://api.thepeer.co/users

Query Parameters

Name	Description	Required	Data type
page	The page number to return. If not specify we use a default to page 1	false	Integer
perPage	The number of records to return per page. If not specify we use a default value of 10	false	Integer

Sample response

{
  "indexed_users": {
    "data": [
      {
        "reference": "the-nothing-the-ghost",
        "name": "Trojan Okoh",
        "identifier": "trojan",
        "identifier_type": "username",
        "email": "trojan@thepeer.co",
        "created_at": "2023-02-20T17:55:01.000000Z",
        "updated_at": "2023-02-20T17:55:01.000000Z"
      },
      {
        "reference": "design-wise-design-god",
        "name": "Chike Ononye",
        "identifier": "chike",
        "identifier_type": "username",
        "email": "chike@thepeer.co",
        "created_at": "2023-02-27T13:02:53.000000Z",
        "updated_at": "2023-02-27T13:02:53.000000Z"
      },
      {
        "reference": "the-real-eze-mmuo",
        "name": "Kamsi Oleka",
        "identifier": "kamsi",
        "identifier_type": "username",
        "email": "kamsy@thepeer.co",
        "created_at": "2023-02-20T17:54:33.000000Z",
        "updated_at": "2023-02-20T17:54:33.000000Z"
      }
    ]
  },
  "meta": {
    "page": 1,
    "total": 4,
    "pageCount": 2,
    "perPage": 3
  }
}