Get User List

GET 
https://api.cleverhub.co/api/v2/cashbacks/users

Retrieves a paginated list of users associated with the site. This endpoint allows merchants to view all users who have activated their cashback accounts, including their personal information and account creation dates. Supports pagination to manage large datasets.

Request

Query Parameters

page integer
The page number to retrieve in the paginated response. Defaults to 1 if not specified.
Default value: 1
Example: 1
per_page integer
The number of records to display per page. Defaults to 10 if not specified.
Default value: 10
Example: 10

Responses

200

A successful response containing a list of users.

application/json

Schema

Schema

pageinteger
The current page number in the paginated response.
Example: 1
per_pageinteger
The number of records displayed per page.
Example: 2
next_pageintegernullable
The page number of the next page, or null if there is no subsequent page.
Example: null
total_pageinteger
The total number of pages available based on the current query.
Example: 1
total_countinteger
The total number of users available across all pages.
Example: 1
records object[]
An array of user objects for the current page.
Array [
user_idstring
The unique identifier of the user.
Example: 8GAVZZKTI3
site_idstring
The unique identifier of the site associated with the user.
Example: 3BAVFJ6H
first_namestring
The user's first name.
Example: example
last_namestring
The user's last name.
Example: example
emailstring
The user's email address.
Example: example@gmail.com
phonestring
The user's phone number.
Example: +61412345678
created_atdate-time
The timestamp when the user was created.
Example: 2024-11-06T16:39:48.264Z
updated_atdate-time
The timestamp when the user's information was last updated.
Example: 2024-11-06T16:39:48.264Z
]

Example (auto)

{
  "page": 1,
  "per_page": 2,
  "next_page": null,
  "total_page": 1,
  "total_count": 1,
  "records": [
    {
      "user_id": "8GAVZZKTI3",
      "site_id": "3BAVFJ6H",
      "first_name": "example",
      "last_name": "example",
      "email": "example@gmail.com",
      "phone": "+61412345678",
      "created_at": "2024-11-06T16:39:48.264Z",
      "updated_at": "2024-11-06T16:39:48.264Z"
    }
  ]
}

400

Bad Request

401

Unauthorized

Authorization: app-id

name: app-idtype: apiKeyin: headerdescription: A unique identifier assigned to each application.

name: secret-keytype: apiKeyin: headerdescription: A secure token associated with the `app-id`.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v2/cashbacks/users");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Parameters

page — query

per_page — query

ResponseClear

Click the Send API Request button above and see the response here!