Skip to main content
GET
/
api
/
external
/
eligible-users
Get Eligible Users
curl --request GET \
  --url https://backend.nebuly.com/api/external/eligible-users \
  --header 'Authorization: Bearer <token>'
{ "users": 
  [
    {
      "end_user": "alice@example.com",
      "tags": { 
        "Product Tier": "Premium", 
        "Country": "US" 
      },
      "active_from": "2026-01-01",
    },
    {
      "end_user": "bob@example.com",
      "tags": { 
        "Product Tier": "Standard", 
        "Country": "CA" 
      },
      "active_from": "2025-06-23",
      "active_to": "2026-01-12"
    }
  ] 
}
This endpoint allows you to fetch the list of eligible users that have been previously inserted for a specific project. You need an API key to authenticate. See here for more information about the API keys.
users
PlatformUser[]
A list of all users stored for your project.
{ "users": 
  [
    {
      "end_user": "alice@example.com",
      "tags": { 
        "Product Tier": "Premium", 
        "Country": "US" 
      },
      "active_from": "2026-01-01",
    },
    {
      "end_user": "bob@example.com",
      "tags": { 
        "Product Tier": "Standard", 
        "Country": "CA" 
      },
      "active_from": "2025-06-23",
      "active_to": "2026-01-12"
    }
  ] 
}