Skip to Content

Public API quickstart

Make your first authenticated request to the organization API.

Use the public API to connect server-side integrations to your organization. The base URL is your TaxCRM site URL followed by /api/v1. Replace https://your-app.example in the examples with your TaxCRM site URL.

Create a key

Sign in as an organization owner or admin, select your organization, and open Settings → Firm Settings → API → API keys. Choose Create API key, enter a description, and optionally choose an expiration time.

Copy the key when it appears. It is shown only once.

Store the key on your server

Set API_KEY in your integration's server environment or secret manager. Keep it out of source control, URLs, and client-side JavaScript.

Make a request

curl --fail-with-body https://your-app.example/api/v1/organization \
  -H "X-API-Key: $API_KEY"

A successful request returns 200 with the organization associated with your key. See the organization endpoint for the full response.

API reference

OpenAPI specification

Import the OpenAPI JSON specification into Swagger, Postman, or another compatible API client. It describes the endpoint, authentication header, response schema, and error statuses.

API scope

Every key can read organization details and the member directory. Owners and admins can grant each key additional read or write access to leads and clients from the dashboard.

On this page