Paginated user list with filters and operator tags (masked columns only)

Requires VIEWER. Many optional filter query params.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

Query Parameters

page

integer

default: 1 >= 1 <= 10000

pageSize

integer

default: 20 >= 1 <= 100

startDate

string

endDate

string

locale

string

hasEmail

Tri-bool: 1/true/0/false.

string

hasPhone

Tri-bool.

string

userIdLike

string

tag

string

paidStatus

string

valueTier

string

minLtv

number

maxLtv

number

minBalance

number

maxBalance

number

minUsage30d

number

maxUsage30d

number

lastPurchaseFrom

string

lastPurchaseTo

string

sort

<col>:<dir>; col in [last_identified_at, first_identified_at, ltv, balance, lastPurchaseAt, usage30d, valueScore], dir in [asc, desc].

string

Responses

200

User page.

application/json

object

users

Array<object>

object

key

additional properties

any

total

integer

page

integer

pageSize

integer

400

Missing/invalid path input (e.g. projectId) or invalid JSON body.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

GET

/api/projects/{projectId}/users

1
curl --request GET \
2
  --url 'https://retidal.com/api/projects/%3Cstring%3E/users?page=1&pageSize=20' \
3
  --cookie trackly_session=%3CYOUR_API_KEY%3E

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/users?page=1&pageSize=20';
2
const options = {method: 'GET', headers: {cookie: 'trackly_session=%3CYOUR_API_KEY%3E'}};
3

4
try {
5
  const response = await fetch(url, options);
6
  const data = await response.json();
7
  console.log(data);
8
} catch (error) {
9
  console.error(error);
10
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/users"
4

5
querystring = {"page":"1","pageSize":"20"}
6

7
headers = {"cookie": "trackly_session=%3CYOUR_API_KEY%3E"}
8

9
response = requests.get(url, headers=headers, params=querystring)
10

11
print(response.json())

1
import httpx
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/users"
4

5
params = [("page", "1"), ("pageSize", "20")]
6

7
cookies = {"trackly_session": "<YOUR_API_KEY>"}
8

9
response = httpx.get(url, params=params, cookies=cookies)
10

11
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "net/http"
6
  "io"
7
)
8

9
func main() {
10

11
  url := "https://retidal.com/api/projects/%3Cstring%3E/users?page=1&pageSize=20"
12

13
  req, _ := http.NewRequest("GET", url, nil)
14

15
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
16

17
  res, _ := http.DefaultClient.Do(req)
18

19
  defer res.Body.Close()
20
  body, _ := io.ReadAll(res.Body)
21

22
  fmt.Println(res)
23
  fmt.Println(string(body))
24

25
}

200User page.

1
{
2
  "users": [
3
    {}
4
  ],
5
  "total": 1,
6
  "page": 1,
7
  "pageSize": 1
8
}

Paginated user list with filters and operator tags (masked columns only)

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

400

Examplegenerated

403

Examplegenerated

Example^generated

Example^generated