accounts

get/api/projects/{project_id}/accounts/by_external_id/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/accounts/by_external_id/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

external_idstring required

Exact external account identifier. Leading and trailing whitespace is significant.

Response

idstring uuid required
namestring required

Human-readable name of the account.

external_idstring nullable

Identifier linking this account to its source customer — the analytics group key (the customer's organization id), used to match billing and external records. Optional.

tagsstring[]

Tag names attached to the account. Pass a list to replace existing tags.

notebooksstring[] required

Short IDs of the internal notebooks linked to this account, used to persist investigations, call notes, and other free-form context. Empty list if no notebooks have been created for the account.

churned_atstring date-time nullable

When the account churned. Null means the account has not churned.

ignored_atstring date-time nullable

When the account was ignored, set by Track Rules or by hand. Null means the account is tracked.

created_atstring date-time required
created_byinteger nullable required
updated_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.