Organization identifier (may be optional depending on auth)
limit
Number of results per page
offset
Pagination offset
Pitfalls
:
Project IDs are numeric; used as parameters in most other endpoints
Organization ID may be required; check your PostHog setup
Pagination is offset-based; iterate until results are empty
Project settings include API keys and configuration details
5. User Profile and Authentication
When to use
User wants to check current user details or verify API access
Tool sequence
:
POSTHOG_WHOAMI
- Get current API user information [Optional]
POSTHOG_RETRIEVE_CURRENT_USER_PROFILE
- Get detailed user profile [Optional]
Key parameters
:
No required parameters for either call
Returns current authenticated user's details, permissions, and organization info
Pitfalls
:
WHOAMI is a lightweight check; use for verifying API connectivity
User profile includes organization membership and permissions
These endpoints confirm the API key's access level and scope
Common Patterns
ID Resolution
Organization -> Project ID
:
1. Call POSTHOG_LIST_PROJECTS_IN_ORGANIZATION_WITH_PAGINATION
2. Find project by name in results
3. Extract id (numeric) for use in other endpoints
Feature flag name -> Flag ID
:
1. Call POSTHOG_LIST_AND_MANAGE_PROJECT_FEATURE_FLAGS with project_id
2. Find flag by key or name
3. Extract id for detailed operations
Feature Flag Targeting
Feature flags support sophisticated targeting:
{
"filters"
:
{
"groups"
:
[
{
"properties"
:
[
{
"key"
:
"email"
,
"value"
:
"@company.com"
,
"operator"
:
"icontains"
}
]
,
"rollout_percentage"
:
100
}
,
{
"properties"
:
[
]
,
"rollout_percentage"
:
10
}
]
}
}
Groups are evaluated in order; first matching group determines the rollout
Properties filter users by their traits
Rollout percentage determines what fraction of matching users see the flag
Pagination
Events: Use
offset
and
limit
(offset-based)
Feature flags: Use
offset
and
limit
(offset-based)
Projects: Use
offset
and
limit
(offset-based)
Continue until results array is empty or smaller than
limit
Known Pitfalls
Project IDs
:
Required for most API endpoints
Always resolve project names to numeric IDs first
Multiple projects can exist in one organization
Event Naming
:
System events use
$
prefix ($pageview, $identify, $autocapture)
Custom events should NOT use
$
prefix
Event names are case-sensitive; maintain consistency
Feature Flags
:
Flag keys must be unique within a project
Use kebab-case for flag keys
Changes propagate within seconds
Deleting a flag is permanent; consider disabling instead
Rate Limits
:
Event ingestion has throughput limits
Batch events where possible for efficiency
API endpoints have per-minute rate limits
Response Parsing
:
Response data may be nested under
data
or
results
key
Paginated responses include
count
,
next
,
previous
fields
Event properties are nested objects; access carefully
Parse defensively with fallbacks for optional fields
Quick Reference
Task
Tool Slug
Key Params
Capture event
POSTHOG_CAPTURE_EVENT
event, distinct_id, properties
List events
POSTHOG_LIST_AND_FILTER_PROJECT_EVENTS
project_id, event, after, before
List feature flags
POSTHOG_LIST_AND_MANAGE_PROJECT_FEATURE_FLAGS
project_id
Get flag details
POSTHOG_RETRIEVE_FEATURE_FLAG_DETAILS
project_id, id
Create flag
POSTHOG_CREATE_FEATURE_FLAGS_FOR_PROJECT
project_id, key, filters
List projects
POSTHOG_LIST_PROJECTS_IN_ORGANIZATION_WITH_PAGINATION
organization_id
Who am I
POSTHOG_WHOAMI
(none)
User profile
POSTHOG_RETRIEVE_CURRENT_USER_PROFILE
(none)
Powered by
Composio