What You Can Do¶

• Browse all available REST API endpoints organized by category

• View required and optional parameters for each endpoint

• Inspect example request and response schemas

• Execute live API calls directly from the browser using your credentials

Authentication¶

Most endpoints require authentication. The Swagger UI supports authenticating with a Personal Access Token (PAT), which is the recommended method.

To authenticate in Swagger UI:

1. Generate a PAT using the api/v1/Account/CreateUserAccessToken endpoint (or use an existing one).

2. Click the Authorize button at the top right of the Swagger UI page.

3. Enter your token in the format PAT <your-token> and click Authorize.

Once authorized, subsequent calls made from the Swagger UI will include your token automatically.

The CmsHost Header¶

Because the Swagger UI is hosted at the shared api.tpsdb.com domain rather than your church’s own URL, most endpoints require a CmsHost header so that the API knows which church database to direct the request to.

Set the CmsHost header to your church’s TouchPoint subdomain — for example:

CmsHost: mychurch

You can provide this header in two ways:

• Per-request — Add it manually in the request headers panel when expanding an endpoint in Swagger UI.

• Globally via Authorize — Click the Authorize button, find the CmsHost field, enter your hostname, and click Authorize. This applies the header to all subsequent requests automatically, alongside your PAT.

Initial documentation for Swagger API Documentation Site