Skip to main content
GET
/
api
/
v1
/
dev
/
teams
/
{teamId}
/
customers
List Customers
curl --request GET \
  --url https://app.lukittu.com/api/v1/dev/teams/{teamId}/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "hasNextPage": false,
    "customers": [
      {
        "id": "789e0123-e89b-12d3-a456-426614174222",
        "email": "[email protected]",
        "fullName": "John Doe",
        "username": "johndoe",
        "metadata": [
          {
            "key": "tier",
            "value": "premium",
            "locked": false
          }
        ],
        "address": {
          "street": "123 Main St",
          "city": "Anytown",
          "state": "CA",
          "country": "US",
          "postalCode": "12345"
        },
        "discordAccount": {
          "id": "111e2222-e89b-12d3-a456-426614174999",
          "customerId": "789e0123-e89b-12d3-a456-426614174222",
          "discordId": "123456789012345678",
          "username": "johndoe_discord",
          "avatar": "a1b2c3d4e5f6g7h8i9j0",
          "createdAt": "2023-09-15T14:30:00Z",
          "updatedAt": "2023-09-15T14:30:00Z"
        },
        "teamId": "123e4567-e89b-12d3-a456-426614174000",
        "createdByUserId": "456e7890-e89b-12d3-a456-426614174111",
        "createdAt": "2023-09-15T14:30:00Z",
        "updatedAt": "2023-09-15T14:30:00Z"
      },
      {
        "id": "890f1234-e89b-12d3-a456-426614174333",
        "email": "[email protected]",
        "fullName": "Jane Smith",
        "username": "janesmith",
        "metadata": [],
        "address": {
          "street": "456 Oak Ave",
          "city": "Elsewhere",
          "state": "NY",
          "country": "US",
          "postalCode": "54321"
        },
        "discordAccount": null,
        "teamId": "123e4567-e89b-12d3-a456-426614174000",
        "createdByUserId": "456e7890-e89b-12d3-a456-426614174111",
        "createdAt": "2023-09-14T10:15:00Z",
        "updatedAt": "2023-09-14T10:15:00Z"
      }
    ]
  },
  "result": {
    "timestamp": "2023-09-15T14:30:00Z",
    "valid": true,
    "details": "Customers found"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication for development endpoints.

You can create API keys in your team's settings on the Lukittu dashboard. Include the API key in the Authorization header as: Bearer YOUR_API_KEY

Example:

Authorization: Bearer lukittu_api_key_abc123def456...

Path Parameters

​
teamId
string<uuid>
required

Your team's UUID. You can find this value in your team's settings on the Lukittu dashboard. UUID v4 identifier

Query Parameters

​
page
integer
default:1

Page number for pagination (1-based)

Required range: x >= 1
​
pageSize
enum<integer>
default:25

Number of items per page

Available options:
10,
25,
50,
100
​
sortColumn
enum<string>
default:createdAt

Column to sort by

Available options:
fullName,
createdAt,
updatedAt,
email,
username
​
sortDirection
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
search
string

Search customers by email, full name, or username

Required string length: 1 - 255

Response

Customers retrieved successfully

​
data
object
​
result
object