GET
/
tail
/
users
curl --request GET \
  --url https://api.flyingraccoon.tech/tail/users \
  --header 'raccoon-secret-key: <api-key>'
{
  "users": [
    {
      "avatar": "https://example.com/avatar.jpg",
      "createdAt": 1678800000,
      "email": "john.doe@example.com",
      "name": "John Doe",
      "raccoonPasscode": "user_raccoon_789"
    }
  ],
  "adminRaccoonPasscode": "admin_secret",
  "meta": {
    "totalPages": 5,
    "totalRecords": 50,
    "currentPage": 1
  }
}

Authorizations

​
raccoon-secret-key
string
header
required

Query Parameters

​
searchQuery
string | null
​
emailId
string | null
​
raccoonPasscode
string | null
​
page
integer | null
default:1
Required range: x >= 1
​
limit
integer | null
default:10
Required range: 1 <= x <= 50
​
sortBy
enum<string> | null
default:createdAt
Available options:
createdAt,
name,
email,
raccoonPasscode
​
sortOrder
enum<string> | null
default:descend
Available options:
ascend,
descend

Response

200
application/json
Successful Response
​
users
object[]
required

List of users.

Example:
[
  {
    "avatar": "https://example.com/avatar.jpg",
    "createdAt": 1678800000,
    "email": "john.doe@example.com",
    "name": "John Doe",
    "raccoonPasscode": "user_raccoon_789"
  }
]
​
adminRaccoonPasscode
string
required

Admin Raccoon passcode.

Example:

"admin_secret"

​
meta
object
required

Metadata about the user list.

Was this page helpful?

Previous
Apps
Next