API

APIs

TouchPoint exposes several REST APIs depending on what you’re trying to accomplish — exploring what’s available, reading data out of the system, writing data into it, authenticating users, or single-sign-on into TouchPoint pages from an external site. The sections below describe each option and link to its full documentation.

Tip

Not sure where to start? Use the interactive Swagger API Documentation Site to browse every endpoint, see its parameters, and test calls right from your browser: https://api.tpsdb.com/api/swagger/ui

Interactive API Explorer

Swagger API Documentation

A browsable, interactive reference for every REST endpoint TouchPoint exposes, powered by Swagger UI. It’s the fastest way to see what’s possible and try a call before writing any code.

  • Browse all REST endpoints organized by category, with their parameters and schemas

  • Inspect example request and response formats

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

Authentication

Personal Access Tokens

Personal Access Tokens (PATs) are the recommended way to authenticate API calls without storing a username and password in the calling system.

  • Create and revoke your own tokens from the profile menu in TouchPoint

  • Set an optional expiration date so a token retires itself

  • Manage tokens programmatically through the API as part of a larger integration

  • Admins can impersonate another user’s API calls with the x-on-behalf-of header

TouchPoint Authentication in External Applications

Use TouchPoint itself as the login system for an external application, so your congregants don’t need a separate username and password for your website.

  • Generate a one-time token for a user that expires after use or five minutes

  • Validate a token with api/v1/Account/ValidateOneTimeLogin

  • Embed the token automatically in Giving Page redirect URLs and mobile app banners

  • Send users from an external system back into TouchPoint already signed in

Reading Data

OData API

A readonly API that follows the OData standard for querying People, Contributions, Pledges, Funds, Organizations, and lookup tables.

  • Standard OData query options, such as $filter, $top, and $skip

  • Returns up to 1000 records per call, with a link to the next page when there are more

  • Built-in endpoints for People, Contributions, Pledges, Funds, Organizations, and Lookups

  • A custom endpoint that exposes any SQL script from Special Content as its own API route

Writing Data

Push Post API

Add records to TouchPoint from an external system — useful for giving integrations, text-to-give services, and similar systems that need to post data in.

  • AddContribution records a gift, matching it to an existing person or creating a new one

  • ReverseContribution reverses a gift and notifies Finance personnel at the church

  • Requires a user with the Developer, APIOnly, and APIWrite roles