Organizations

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET
POST
GET
PATCH
DELETE
POST
POST
GET
GET
GET
GET
GET
GET
Next page →

Retrieve

Required API key scopes

organization:read

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/organizations
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "membership_level": 1,
      "plugins_access_level": 0,
      "teams": [
        {}
      ],
      "projects": [
        {}
      ],
      "available_product_features": [
        null
      ],
      "is_member_join_email_enabled": true,
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "customer_id": "string",
      "enforce_2fa": true,
      "enforce_verified_domains": true,
      "members_can_invite": true,
      "members_can_create_projects": true,
      "members_can_use_personal_api_keys": true,
      "members_can_see_org_members": true,
      "allow_publicly_shared_resources": true,
      "read_only_mcp_access": true,
      "member_count": 0,
      "is_ai_data_processing_approved": true,
      "is_ai_training_opted_in": true,
      "is_ai_training_locked": true,
      "is_ai_training_cta_shown": true,
      "has_signed_baa": true,
      "default_anonymize_ips": true,
      "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
      "is_active": true,
      "is_not_active_reason": "string",
      "is_pending_deletion": true,
      "uses_most_specific_access_resolution": true
    }
  ]
}

Retrieve

Required API key scopes

organization:read

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/organizations
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "membership_level": 1,
      "plugins_access_level": 0,
      "teams": [
        {}
      ],
      "projects": [
        {}
      ],
      "available_product_features": [
        null
      ],
      "is_member_join_email_enabled": true,
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "customer_id": "string",
      "enforce_2fa": true,
      "enforce_verified_domains": true,
      "members_can_invite": true,
      "members_can_create_projects": true,
      "members_can_use_personal_api_keys": true,
      "members_can_see_org_members": true,
      "allow_publicly_shared_resources": true,
      "read_only_mcp_access": true,
      "member_count": 0,
      "is_ai_data_processing_approved": true,
      "is_ai_training_opted_in": true,
      "is_ai_training_locked": true,
      "is_ai_training_cta_shown": true,
      "has_signed_baa": true,
      "default_anonymize_ips": true,
      "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
      "is_active": true,
      "is_not_active_reason": "string",
      "is_pending_deletion": true,
      "uses_most_specific_access_resolution": true
    }
  ]
}

Create

Required API key scopes

organization:write

Request parameters

  • name
    string
  • logo_media_id
    stringnull
  • enforce_2fa
    booleannull
  • enforce_verified_domains
    booleannull
  • members_can_invite
    booleannull
  • members_can_create_projects
    booleannull
  • members_can_use_personal_api_keys
    boolean
  • members_can_see_org_members
    boolean
  • allow_publicly_shared_resources
    boolean
  • read_only_mcp_access
    booleannull
  • is_ai_data_processing_approved
    booleannull
  • is_ai_training_opted_in
    booleannull
  • default_anonymize_ips
    boolean
  • default_role_id
    stringnull

Response


Example request

POST /api/organizations
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/\
	-d name="string"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {}
  ],
  "projects": [
    {}
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "enforce_verified_domains": true,
  "members_can_invite": true,
  "members_can_create_projects": true,
  "members_can_use_personal_api_keys": true,
  "members_can_see_org_members": true,
  "allow_publicly_shared_resources": true,
  "read_only_mcp_access": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "is_ai_training_opted_in": true,
  "is_ai_training_locked": true,
  "is_ai_training_cta_shown": true,
  "has_signed_baa": true,
  "default_anonymize_ips": true,
  "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
  "is_active": true,
  "is_not_active_reason": "string",
  "is_pending_deletion": true,
  "uses_most_specific_access_resolution": true
}

Create

Required API key scopes

organization:write

Request parameters

  • name
    string
  • logo_media_id
    stringnull
  • enforce_2fa
    booleannull
  • enforce_verified_domains
    booleannull
  • members_can_invite
    booleannull
  • members_can_create_projects
    booleannull
  • members_can_use_personal_api_keys
    boolean
  • members_can_see_org_members
    boolean
  • allow_publicly_shared_resources
    boolean
  • read_only_mcp_access
    booleannull
  • is_ai_data_processing_approved
    booleannull
  • is_ai_training_opted_in
    booleannull
  • default_anonymize_ips
    boolean
  • default_role_id
    stringnull

Response


Example request

POST /api/organizations
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/\
	-d name="string"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {}
  ],
  "projects": [
    {}
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "enforce_verified_domains": true,
  "members_can_invite": true,
  "members_can_create_projects": true,
  "members_can_use_personal_api_keys": true,
  "members_can_see_org_members": true,
  "allow_publicly_shared_resources": true,
  "read_only_mcp_access": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "is_ai_training_opted_in": true,
  "is_ai_training_locked": true,
  "is_ai_training_cta_shown": true,
  "has_signed_baa": true,
  "default_anonymize_ips": true,
  "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
  "is_active": true,
  "is_not_active_reason": "string",
  "is_pending_deletion": true,
  "uses_most_specific_access_resolution": true
}

Retrieve

Required API key scopes

organization:read

Path parameters

  • id
    string

Response


Example request

GET /api/organizations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {}
  ],
  "projects": [
    {}
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "enforce_verified_domains": true,
  "members_can_invite": true,
  "members_can_create_projects": true,
  "members_can_use_personal_api_keys": true,
  "members_can_see_org_members": true,
  "allow_publicly_shared_resources": true,
  "read_only_mcp_access": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "is_ai_training_opted_in": true,
  "is_ai_training_locked": true,
  "is_ai_training_cta_shown": true,
  "has_signed_baa": true,
  "default_anonymize_ips": true,
  "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
  "is_active": true,
  "is_not_active_reason": "string",
  "is_pending_deletion": true,
  "uses_most_specific_access_resolution": true
}

Retrieve

Required API key scopes

organization:read

Path parameters

  • id
    string

Response


Example request

GET /api/organizations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {}
  ],
  "projects": [
    {}
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "enforce_verified_domains": true,
  "members_can_invite": true,
  "members_can_create_projects": true,
  "members_can_use_personal_api_keys": true,
  "members_can_see_org_members": true,
  "allow_publicly_shared_resources": true,
  "read_only_mcp_access": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "is_ai_training_opted_in": true,
  "is_ai_training_locked": true,
  "is_ai_training_cta_shown": true,
  "has_signed_baa": true,
  "default_anonymize_ips": true,
  "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
  "is_active": true,
  "is_not_active_reason": "string",
  "is_pending_deletion": true,
  "uses_most_specific_access_resolution": true
}

Update partial

Required API key scopes

organization:write

Path parameters

  • id
    string

Request parameters

  • name
    string
  • logo_media_id
    stringnull
  • enforce_2fa
    booleannull
  • enforce_verified_domains
    booleannull
  • members_can_invite
    booleannull
  • members_can_create_projects
    booleannull
  • members_can_use_personal_api_keys
    boolean
  • members_can_see_org_members
    boolean
  • allow_publicly_shared_resources
    boolean
  • read_only_mcp_access
    booleannull
  • is_ai_data_processing_approved
    booleannull
  • is_ai_training_opted_in
    booleannull
  • default_anonymize_ips
    boolean
  • default_role_id
    stringnull

Response


Example request

PATCH /api/organizations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {}
  ],
  "projects": [
    {}
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "enforce_verified_domains": true,
  "members_can_invite": true,
  "members_can_create_projects": true,
  "members_can_use_personal_api_keys": true,
  "members_can_see_org_members": true,
  "allow_publicly_shared_resources": true,
  "read_only_mcp_access": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "is_ai_training_opted_in": true,
  "is_ai_training_locked": true,
  "is_ai_training_cta_shown": true,
  "has_signed_baa": true,
  "default_anonymize_ips": true,
  "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
  "is_active": true,
  "is_not_active_reason": "string",
  "is_pending_deletion": true,
  "uses_most_specific_access_resolution": true
}

Update partial

Required API key scopes

organization:write

Path parameters

  • id
    string

Request parameters

  • name
    string
  • logo_media_id
    stringnull
  • enforce_2fa
    booleannull
  • enforce_verified_domains
    booleannull
  • members_can_invite
    booleannull
  • members_can_create_projects
    booleannull
  • members_can_use_personal_api_keys
    boolean
  • members_can_see_org_members
    boolean
  • allow_publicly_shared_resources
    boolean
  • read_only_mcp_access
    booleannull
  • is_ai_data_processing_approved
    booleannull
  • is_ai_training_opted_in
    booleannull
  • default_anonymize_ips
    boolean
  • default_role_id
    stringnull

Response


Example request

PATCH /api/organizations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {}
  ],
  "projects": [
    {}
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "enforce_verified_domains": true,
  "members_can_invite": true,
  "members_can_create_projects": true,
  "members_can_use_personal_api_keys": true,
  "members_can_see_org_members": true,
  "allow_publicly_shared_resources": true,
  "read_only_mcp_access": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "is_ai_training_opted_in": true,
  "is_ai_training_locked": true,
  "is_ai_training_cta_shown": true,
  "has_signed_baa": true,
  "default_anonymize_ips": true,
  "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
  "is_active": true,
  "is_not_active_reason": "string",
  "is_pending_deletion": true,
  "uses_most_specific_access_resolution": true
}

Delete

Required API key scopes

organization:write

Path parameters

  • id
    string

Example request

DELETE /api/organizations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:id/

Example response

Status 204 No response body

Delete

Required API key scopes

organization:write

Path parameters

  • id
    string

Example request

DELETE /api/organizations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:id/

Example response

Status 204 No response body

Create remove blocked members and enforce verified domains

Remove the members whose email domain is outside the organization's verified domains and turn enforce_verified_domains on, in one transaction. Owners are never removed; they keep gated access and can disable the setting themselves. Admin only.

Use this only when the caller has confirmed the removals. To turn the setting on without touching memberships, PATCH enforce_verified_domains on the organization instead.

Path parameters

  • id
    string

Response


Example request

POST /api/organizations/:id/remove_blocked_members_and_enforce_verified_domains
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:id/remove_blocked_members_and_enforce_verified_domains/

Example response

Status 200
RESPONSE
{
  "success": true,
  "removed_members": 0
}

Create request ai access

Notify organization admins that a member is requesting PostHog AI be enabled.

Path parameters

  • id
    string

Response


Example request

POST /api/organizations/:id/request_ai_access
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:id/request_ai_access/

Example response

Status 200
RESPONSE
{
  "success": true
}

Retrieve teams data freshness

When each project in the organization last received data, broken down by kind of data.

Required API key scopes

organization:read

Path parameters

  • id
    string

Response


Example request

GET /api/organizations/:id/teams/data_freshness
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:id/teams/data_freshness/

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "team_id": 0,
      "freshness": "never",
      "last_data_at": "2019-08-24T14:15:22Z",
      "sources": [
        {
          "data_source": "string",
          "last_data_at": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "lookback_days": 0,
  "quiet_after_days": 0
}

Retrieve billing features

In beta: the organization billing API is behind the organization-billing-api feature flag and answers 403 without it, so ask support for access. Its shapes may change while it is in beta.

Required API key scopes

billing:read

Response


Example request

GET /api/organizations/:organization_id/billing/features
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/billing/features/

Example response

Status 200
RESPONSE
{
  "available_product_features": [
    {
      "key": "string",
      "name": "string",
      "description": "string",
      "unit": "string",
      "limit": 0,
      "note": "string",
      "is_plan_default": true,
      "entitlement_only": true,
      "category": "string"
    }
  ]
}

Retrieve billing forecast

In beta: the organization billing API is behind the organization-billing-api feature flag and answers 403 without it, so ask support for access. Its shapes may change while it is in beta.

Required API key scopes

billing:read

Response


Example request

GET /api/organizations/:organization_id/billing/forecast
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/billing/forecast/

Example response

Status 200
RESPONSE
{
  "billing_period": {
    "current_period_start": "2019-08-24T14:15:22Z",
    "current_period_end": "2019-08-24T14:15:22Z",
    "interval": "month"
  },
  "projected_total_amount_usd": "string",
  "projected_total_amount_usd_with_limit": "string",
  "projected_total_amount_usd_after_discount": "string",
  "projected_total_amount_usd_with_limit_after_discount": "string",
  "products": [
    {
      "kind": "product",
      "key": "string",
      "usage_key": "string",
      "projected_usage": 0,
      "projected_amount_usd": "string",
      "projected_amount_usd_with_limit": "string",
      "tier_forecast": [
        {
          "up_to": 0,
          "projected_usage": 0,
          "projected_amount_usd": "string"
        }
      ],
      "addons": [
        {
          "kind": "product",
          "key": "string",
          "usage_key": "string",
          "projected_usage": 0,
          "projected_amount_usd": "string",
          "projected_amount_usd_with_limit": "string",
          "tier_forecast": [
            {
              "up_to": 0,
              "projected_usage": 0,
              "projected_amount_usd": "string"
            }
          ]
        }
      ]
    }
  ],
  "computed_at": "2019-08-24T14:15:22Z"
}

List all billing invoices

In beta: the organization billing API is behind the organization-billing-api feature flag and answers 403 without it, so ask support for access. Its shapes may change while it is in beta.

Required API key scopes

billing:read

Query parameters

  • cursor
    string
  • limit
    integer
  • status
    string
    One of: "open""paid""uncollectible""void"

Response


Example request

GET /api/organizations/:organization_id/billing/invoices
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/billing/invoices/

Example response

Status 200
RESPONSE
{
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    {
      "id": "string",
      "number": "string",
      "status": "open",
      "currency": "string",
      "subtotal": "string",
      "total": "string",
      "amount_due": "string",
      "amount_paid": "string",
      "period_start": "2019-08-24T14:15:22Z",
      "period_end": "2019-08-24T14:15:22Z",
      "created": "2019-08-24T14:15:22Z",
      "due_date": "2019-08-24T14:15:22Z"
    }
  ]
}

Retrieve billing invoices content

In beta: the organization billing API is behind the organization-billing-api feature flag and answers 403 without it, so ask support for access. Its shapes may change while it is in beta.

Required API key scopes

billing:read

Path parameters

  • invoice_id
    string

Example request

GET /api/organizations/:organization_id/billing/invoices/:invoice_id/content
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/billing/invoices/:invoice_id/content/

Example response

Status 200

Retrieve billing limits

In beta: the organization billing API is behind the organization-billing-api feature flag and answers 403 without it, so ask support for access. Its shapes may change while it is in beta.

Required API key scopes

billing:read

Response


Example request

GET /api/organizations/:organization_id/billing/limits
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/billing/limits/

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "key": "string",
      "limit_usd": 0,
      "next_period_limit_usd": 0,
      "spend_usd": "string",
      "reached": true
    }
  ]
}
Next page →