Code API Reference

Code

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

Endpoints

`GET`
`POST`

Retrieve code invites check access

Check whether the authenticated user has access to PostHog Code.

Example request

GET /api/code/invites/check-access
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/code/invites/check-access/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/code/invites/check-access/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 Access check result

Create code invites redeem

Redeem a PostHog Code invite code to enable access.

Request parameters

code
string

Example request

POST /api/code/invites/redeem
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/code/invites/redeem/\
	-d code="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/code/invites/redeem/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"code": "string"
	}
).json()

Example response

Status 200 Invite code redeemed successfully

Status 400 Invalid or expired invite code

RESPONSE
{
  "error": "string"
}

Code

Endpoints

Retrieve code invites check access

Example request

Example response

Status 200 Access check result

Create code invites redeem

Request parameters

Example request

Example response

Status 200 Invite code redeemed successfully

Status 400 Invalid or expired invite code

Community questions