Members

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

List all members

Path Parameters

  • parent_lookup_organization_id
    string

Query Parameters

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

Response


Request

GET /api/organizations/:parent_lookup_organization_id/members
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/members/

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",
      "user": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "email": "user@example.com",
        "is_email_verified": true
      },
      "level": 1,
      "joined_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "is_2fa_enabled": true,
      "has_social_auth": true
    }
  ]
}

Update members

Path Parameters

  • parent_lookup_organization_id
    string
  • user__uuid
    string

Request Parameters

  • level
    integer
    One of: "1""8""15"

Response


Request

PATCH /api/organizations/:parent_lookup_organization_id/members/:user__uuid
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/members/:user__uuid/\
	-d user=undefined

Response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "email": "user@example.com",
    "is_email_verified": true
  },
  "level": 1,
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "is_2fa_enabled": true,
  "has_social_auth": true
}

Delete members

Path Parameters

  • parent_lookup_organization_id
    string
  • user__uuid
    string

Request

DELETE /api/organizations/:parent_lookup_organization_id/members/:user__uuid
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/members/:user__uuid/

Response

Status 204 No response body

Questions?

Was this page useful?