Legal

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

Endpoints

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

List all legal documents

Required API key scopes

legal_document:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/organizations/:organization_id/legal_documents
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/legal_documents/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/organizations/{organization_id}/legal_documents/".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",
      "document_type": "string",
      "company_name": "string",
      "representative_email": "string",
      "status": "string",
      "signed_pdf_stored": true,
      "created_by": {
        "first_name": "string",
        "email": "string"
      },
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create legal documents

Required API key scopes

legal_document:write

Request parameters

document_type
company_name
string
company_address
string
representative_email
string

Response

Example request

POST /api/organizations/:organization_id/legal_documents
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/legal_documents/\
	-d document_type=undefined,\
	-d company_name="string",\
	-d company_address="string",\
	-d representative_email="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/organizations/{organization_id}/legal_documents/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"company_name": "string",
		"company_address": "string",
		"representative_email": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "document_type": "string",
  "company_name": "string",
  "representative_email": "string",
  "status": "string",
  "signed_pdf_stored": true,
  "created_by": {
    "first_name": "string",
    "email": "string"
  },
  "created_at": "2019-08-24T14:15:22Z"
}

Retrieve legal documents

Required API key scopes

legal_document:read

Path parameters

id
string

Response

Example request

GET /api/organizations/:organization_id/legal_documents/: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/legal_documents/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/organizations/{organization_id}/legal_documents/{legal_document_id}/".format(
        project_id=project_id,
		legal_document_id="<the legal document id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "document_type": "string",
  "company_name": "string",
  "representative_email": "string",
  "status": "string",
  "signed_pdf_stored": true,
  "created_by": {
    "first_name": "string",
    "email": "string"
  },
  "created_at": "2019-08-24T14:15:22Z"
}

Delete legal documents

Delete an unsigned legal document. The PandaDoc envelope is voided first so the original signer can no longer complete it; only if that succeeds is the row removed, freeing the unique-per-org-per-type constraint so a fresh document can be generated.

Returns 503 if the PandaDoc void fails — the row stays in that case and the frontend should prompt the user to retry. Returns 403 for signed documents (legal artifacts; staff can still delete signed rows from Django admin).

Required API key scopes

legal_document:write

Path parameters

id
string

Example request

DELETE /api/organizations/:organization_id/legal_documents/: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/legal_documents/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/organizations/{organization_id}/legal_documents/{legal_document_id}/".format(
        project_id=project_id,
		legal_document_id="<the legal document id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Status 403 No response body

Status 404 No response body

Status 503 No response body

Retrieve legal documents download

Short-lived redirect to the signed PDF in object storage. 404 while the envelope is still out for signature (or if the upload hasn't completed yet). The underlying presigned URL expires in ~60s; clients should hit this endpoint each time they want to view the PDF rather than caching.

Path parameters

id
string

Example request

GET /api/organizations/:organization_id/legal_documents/:id/download
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/legal_documents/:id/download/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/organizations/{organization_id}/legal_documents/{legal_document_id}/download/".format(
        project_id=project_id,
		legal_document_id="<the legal document id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Legal

Endpoints

List all legal documents

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create legal documents

Required API key scopes

Request parameters

Response

Example request

Example response

Status 201

Retrieve legal documents

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Delete legal documents

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Status 403 No response body

Status 404 No response body

Status 503 No response body

Retrieve legal documents download

Path parameters

Example request

Example response

Status 302 No response body

Status 404 No response body