Developers

Parsepoint API Documentation

Reference docs for authentication, base URLs, and public v1 endpoints.

Redoc

Human-readable interactive documentation.

https://api.app-parsepoint.com/v1/schema/redoc/

Swagger UI

Interactive explorer for request/response testing.

https://api.app-parsepoint.com/v1/schema/swagger-ui/

OpenAPI Schema

Raw OpenAPI schema for code generation and tooling.

https://api.app-parsepoint.com/v1/schema/

Authentication

Primary: Authorization: Bearer <jwt> from Parsepoint ID.
API key support: X-API-Key: pp_live_* or X-API-Key: pp_test_*.
Base URL: https://api.app-parsepoint.com

Example Request

curl -X GET 'https://api.app-parsepoint.com/v1/search/?q=lease&type=all&limit=10' \
  -H 'Authorization: Bearer <jwt>' \
  -H 'X-Organization-ID: <company_id>' \
  -H 'X-Company-ID: <company_id>'

Search

Method	Path	Purpose
GET	`/v1/search/`	Unified search across facilities, leases, folders, and files.

Outbound Webhooks

Method	Path	Purpose
GET	`/v1/webhooks/outbound/endpoints/`	List outbound webhook endpoints for an organization.
POST	`/v1/webhooks/outbound/endpoints/`	Create a new outbound webhook endpoint.
PATCH	`/v1/webhooks/outbound/endpoints/{endpoint_id}/`	Update endpoint settings or subscriptions.
POST	`/v1/webhooks/outbound/endpoints/{endpoint_id}/rotate-secret/`	Rotate endpoint signing secret.
GET	`/v1/webhooks/outbound/deliveries/`	View delivery logs and status.

Document Parse Credits

Method	Path	Purpose
GET	`/v1/document-parse/credits/`	Get current credit balance and usage.
POST	`/v1/document-parse/credits/consume/`	Consume credits with idempotency support.
POST	`/v1/document-parse/credits/adjust/`	Admin adjustment of credits.
GET	`/v1/document-parse/credits/history/`	List credit ledger events.

Integrations

Method	Path	Purpose
GET	`/v1/integrations/me/`	Verify API key connection metadata.
GET	`/v1/integrations/parsed-documents/`	Read parsed-document feed for external automation.
GET	`/v1/integrations/api-keys/`	List integration API keys.
POST	`/v1/integrations/api-keys/`	Create integration API keys with type/scope/expiry.
DELETE	`/v1/integrations/api-keys/{key_id}/`	Revoke integration API key.