Invites
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all invites
Path Parameters
- parent_lookup_organization_idstring
Query Parameters
- limitinteger
- offsetinteger
Response
Request
GET
/api /organizations /:parent_lookup_organization_id /invites
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/invites/
Response
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","target_email": "user@example.com","first_name": "string","emailing_attempt_made": true,"is_expired": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","message": "string"}]}
Create invites
Path Parameters
- parent_lookup_organization_idstring
Request Parameters
- target_emailstring
- first_namestring
- messagestring
Response
Request
POST
/api /organizations /:parent_lookup_organization_id /invites
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/organizations/:parent_lookup_organization_id/invites/\-d target_email="string"
Response
RESPONSE
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","target_email": "user@example.com","first_name": "string","emailing_attempt_made": true,"is_expired": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","message": "string"}
Delete invites
Path Parameters
- idstring
- parent_lookup_organization_idstring
Request
DELETE
/api /organizations /:parent_lookup_organization_id /invites /:id
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/invites/:id/
Response
No responseCreate invites bulk
Path Parameters
- parent_lookup_organization_idstring
Request Parameters
- target_emailstring
- first_namestring
- messagestring
Response
Request
POST
/api /organizations /:parent_lookup_organization_id /invites /bulk
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/organizations/:parent_lookup_organization_id/invites/bulk/\-d target_email="string"
Response
RESPONSE
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","target_email": "user@example.com","first_name": "string","emailing_attempt_made": true,"is_expired": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","message": "string"}