Account Relationship API Reference

Account Relationship

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

Endpoints

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

List all account relationship definitions

Required API key scopes

account:read

Query parameters

limit
integer
offset
integer

Response

Example request

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

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",
      "description": "string",
      "is_single_holder": true
    }
  ]
}

Create account relationship definitions

Required API key scopes

account:write

Request parameters

name
string
description
stringnull
is_single_holder
boolean
Default: true

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "is_single_holder": true
}

Retrieve account relationship definitions

Required API key scopes

account:read

Path parameters

id
string

Response

Example request

GET /api/projects/:project_id/account_relationship_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/account_relationship_definitions/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/account_relationship_definitions/{account_relationship_definition_id}/".format(
        project_id=project_id,
		account_relationship_definition_id="<the account relationship definition id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "is_single_holder": true
}

Update account relationship definitions

Required API key scopes

account:write

Path parameters

id
string

Request parameters

name
string
description
stringnull
is_single_holder
boolean
Default: true

Response

Example request

PATCH /api/projects/:project_id/account_relationship_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/account_relationship_definitions/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/account_relationship_definitions/{account_relationship_definition_id}/".format(
        project_id=project_id,
		account_relationship_definition_id="<the account relationship definition id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "is_single_holder": true
}

Delete account relationship definitions

Required API key scopes

account:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/account_relationship_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/account_relationship_definitions/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/account_relationship_definitions/{account_relationship_definition_id}/".format(
        project_id=project_id,
		account_relationship_definition_id="<the account relationship definition id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Account Relationship

Endpoints

List all account relationship definitions

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create account relationship definitions

Required API key scopes

Request parameters

Response

Example request

Example response

Status 201

Retrieve account relationship definitions

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update account relationship definitions

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete account relationship definitions

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions