Organizations

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

Endpoints

GET
POST
GET
PATCH
DELETE
GET
GET
PATCH
GET
POST
GET
DELETE

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": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "projects": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "available_product_features": [
        null
      ],
      "is_member_join_email_enabled": true,
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "customer_id": "string",
      "enforce_2fa": true,
      "members_can_invite": true,
      "members_can_use_personal_api_keys": true,
      "allow_publicly_shared_resources": true,
      "member_count": 0,
      "is_ai_data_processing_approved": true,
      "default_experiment_stats_method": "bayesian",
      "default_anonymize_ips": true,
      "default_role_id": "string",
      "is_active": true,
      "is_not_active_reason": "string"
    }
  ]
}

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": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "projects": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "available_product_features": [
        null
      ],
      "is_member_join_email_enabled": true,
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "customer_id": "string",
      "enforce_2fa": true,
      "members_can_invite": true,
      "members_can_use_personal_api_keys": true,
      "allow_publicly_shared_resources": true,
      "member_count": 0,
      "is_ai_data_processing_approved": true,
      "default_experiment_stats_method": "bayesian",
      "default_anonymize_ips": true,
      "default_role_id": "string",
      "is_active": true,
      "is_not_active_reason": "string"
    }
  ]
}

Create

Required API key scopes

organization:write

Request parameters

  • name
    string
  • logo_media_id
    string
  • is_member_join_email_enabled
    boolean
  • enforce_2fa
    boolean
  • members_can_invite
    boolean
  • members_can_use_personal_api_keys
    boolean
  • allow_publicly_shared_resources
    boolean
  • is_ai_data_processing_approved
    boolean
  • default_experiment_stats_method
  • default_anonymize_ips
    boolean
  • default_role_id
    string

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": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "projects": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "members_can_invite": true,
  "members_can_use_personal_api_keys": true,
  "allow_publicly_shared_resources": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "default_experiment_stats_method": "bayesian",
  "default_anonymize_ips": true,
  "default_role_id": "string",
  "is_active": true,
  "is_not_active_reason": "string"
}

Create

Required API key scopes

organization:write

Request parameters

  • name
    string
  • logo_media_id
    string
  • is_member_join_email_enabled
    boolean
  • enforce_2fa
    boolean
  • members_can_invite
    boolean
  • members_can_use_personal_api_keys
    boolean
  • allow_publicly_shared_resources
    boolean
  • is_ai_data_processing_approved
    boolean
  • default_experiment_stats_method
  • default_anonymize_ips
    boolean
  • default_role_id
    string

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": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "projects": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "members_can_invite": true,
  "members_can_use_personal_api_keys": true,
  "allow_publicly_shared_resources": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "default_experiment_stats_method": "bayesian",
  "default_anonymize_ips": true,
  "default_role_id": "string",
  "is_active": true,
  "is_not_active_reason": "string"
}

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": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "projects": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "members_can_invite": true,
  "members_can_use_personal_api_keys": true,
  "allow_publicly_shared_resources": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "default_experiment_stats_method": "bayesian",
  "default_anonymize_ips": true,
  "default_role_id": "string",
  "is_active": true,
  "is_not_active_reason": "string"
}

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": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "projects": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "members_can_invite": true,
  "members_can_use_personal_api_keys": true,
  "allow_publicly_shared_resources": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "default_experiment_stats_method": "bayesian",
  "default_anonymize_ips": true,
  "default_role_id": "string",
  "is_active": true,
  "is_not_active_reason": "string"
}

Update partial

Required API key scopes

organization:write

Path parameters

  • id
    string

Request parameters

  • name
    string
  • logo_media_id
    string
  • is_member_join_email_enabled
    boolean
  • enforce_2fa
    boolean
  • members_can_invite
    boolean
  • members_can_use_personal_api_keys
    boolean
  • allow_publicly_shared_resources
    boolean
  • is_ai_data_processing_approved
    boolean
  • default_experiment_stats_method
  • default_anonymize_ips
    boolean
  • default_role_id
    string

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": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "projects": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "members_can_invite": true,
  "members_can_use_personal_api_keys": true,
  "allow_publicly_shared_resources": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "default_experiment_stats_method": "bayesian",
  "default_anonymize_ips": true,
  "default_role_id": "string",
  "is_active": true,
  "is_not_active_reason": "string"
}

Update partial

Required API key scopes

organization:write

Path parameters

  • id
    string

Request parameters

  • name
    string
  • logo_media_id
    string
  • is_member_join_email_enabled
    boolean
  • enforce_2fa
    boolean
  • members_can_invite
    boolean
  • members_can_use_personal_api_keys
    boolean
  • allow_publicly_shared_resources
    boolean
  • is_ai_data_processing_approved
    boolean
  • default_experiment_stats_method
  • default_anonymize_ips
    boolean
  • default_role_id
    string

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": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "projects": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "customer_id": "string",
  "enforce_2fa": true,
  "members_can_invite": true,
  "members_can_use_personal_api_keys": true,
  "allow_publicly_shared_resources": true,
  "member_count": 0,
  "is_ai_data_processing_approved": true,
  "default_experiment_stats_method": "bayesian",
  "default_anonymize_ips": true,
  "default_role_id": "string",
  "is_active": true,
  "is_not_active_reason": "string"
}

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

List all integrations

ViewSet for organization-level integrations.

Provides read-only access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.

This is read-only. Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Deletion requires contacting support due to billing implications.

Required API key scopes

organization_integration:read

Path parameters

  • organization_id
    string

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

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

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",
      "kind": "vercel",
      "integration_id": "string",
      "config": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      }
    }
  ]
}

Retrieve integrations

ViewSet for organization-level integrations.

Provides read-only access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.

This is read-only. Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Deletion requires contacting support due to billing implications.

Required API key scopes

organization_integration:read

Path parameters

  • id
    string
  • organization_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "vercel",
  "integration_id": "string",
  "config": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  }
}

Update integrations environment mapping

ViewSet for organization-level integrations.

Provides read-only access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.

This is read-only. Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Deletion requires contacting support due to billing implications.

Path parameters

  • id
    string
  • organization_id
    string

Request parameters

    Response


    Example request

    PATCH /api/organizations/:organization_id/integrations/:id/environment-mapping
    export POSTHOG_PERSONAL_API_KEY=[your personal api key]
    curl -X PATCH \
        -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
        <ph_app_host>/api/organizations/:organization_id/integrations/:id/environment-mapping/\
    	-d kind=undefined

    Example response

    Status 200
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "kind": "vercel",
      "integration_id": "string",
      "config": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      }
    }

    List all roles role memberships

    Required API key scopes

    organization:read

    Path parameters

    • organization_id
      string
    • role_id
      string

    Query parameters

    • limit
      integer
    • offset
      integer

    Response


    Example request

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

    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",
          "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
          "organization_member": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "user": {
              "id": 0,
              "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
              "distinct_id": "string",
              "first_name": "string",
              "last_name": "string",
              "email": "user@example.com",
              "is_email_verified": true,
              "hedgehog_config": {
                "property1": null,
                "property2": null
              },
              "role_at_organization": "engineering"
            },
            "level": 1,
            "joined_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "is_2fa_enabled": true,
            "has_social_auth": true,
            "last_login": "2019-08-24T14:15:22Z"
          },
          "user": {
            "id": 0,
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "distinct_id": "string",
            "first_name": "string",
            "last_name": "string",
            "email": "user@example.com",
            "is_email_verified": true,
            "hedgehog_config": {
              "property1": null,
              "property2": null
            },
            "role_at_organization": "engineering"
          },
          "joined_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f"
        }
      ]
    }

    Create roles role memberships

    Required API key scopes

    organization:write

    Path parameters

    • organization_id
      string
    • role_id
      string

    Request parameters

    • user_uuid
      string

    Response


    Example request

    POST /api/organizations/:organization_id/roles/:role_id/role_memberships
    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/:organization_id/roles/:role_id/role_memberships/\
    	-d user_uuid="string"

    Example response

    Status 201
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
      "organization_member": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "user": {
          "id": 0,
          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
          "distinct_id": "string",
          "first_name": "string",
          "last_name": "string",
          "email": "user@example.com",
          "is_email_verified": true,
          "hedgehog_config": {
            "property1": null,
            "property2": null
          },
          "role_at_organization": "engineering"
        },
        "level": 1,
        "joined_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "is_2fa_enabled": true,
        "has_social_auth": true,
        "last_login": "2019-08-24T14:15:22Z"
      },
      "user": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "joined_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f"
    }

    Retrieve roles role memberships

    Required API key scopes

    organization:read

    Path parameters

    • id
      string
    • organization_id
      string
    • role_id
      string

    Response


    Example request

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

    Example response

    Status 200
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
      "organization_member": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "user": {
          "id": 0,
          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
          "distinct_id": "string",
          "first_name": "string",
          "last_name": "string",
          "email": "user@example.com",
          "is_email_verified": true,
          "hedgehog_config": {
            "property1": null,
            "property2": null
          },
          "role_at_organization": "engineering"
        },
        "level": 1,
        "joined_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "is_2fa_enabled": true,
        "has_social_auth": true,
        "last_login": "2019-08-24T14:15:22Z"
      },
      "user": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "joined_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f"
    }

    Delete roles role memberships

    Required API key scopes

    organization:write

    Path parameters

    • id
      string
    • organization_id
      string
    • role_id
      string

    Example request

    DELETE /api/organizations/:organization_id/roles/:role_id/role_memberships/: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/:organization_id/roles/:role_id/role_memberships/:id/

    Example response

    Status 204 No response body

    Community questions

    Questions about this page? or post a community question.