Quickstart
Connect to symplr CTM with Nango and see data flow in 2 minutes.1
Create the integration
In Nango (free signup), go to Integrations -> Configure New Integration -> symplr CTM.
3
Call the symplr CTM API
Let’s make your first request to the ClearConnect API (list regions). Replace the placeholders below with your Environment API key, integration ID, and connection ID:Or fetch credentials with the Node SDK or API.You’re connected! Check the Logs tab in Nango to inspect requests.
- cURL
- Node
4
Implement Nango in your app
Follow our quickstart to integrate Nango in your app.To obtain your own credentials, follow the setup guide linked below.
symplr CTM integration guides
Nango-maintained guides for common use cases.- How do I link my symplr CTM account? Find your ClearConnect site name, username and password and connect them to Nango
API gotchas
- ClearConnect is an RPC-style API, not a resource-based REST API: every call goes through a single endpoint,
/2_0/index.cfm, with anactionquery parameter (e.g.?action=getClients&clientIdIn=12015) selecting the actual operation. Copy the exactactionname and its arguments from the endpoint’s own documentation. - The
resultTypequery parameter controls the response format (json,xml,csv,tsv). It is not required, but if omitted the API defaults to XML — always passresultType=json. - Authentication supports two REST patterns: a Basic Authorization header on every request (
Authorization: Basic base64(username:password)), or a session-key exchange (getSessionKeywith Basic auth, thenAuthorization: Bearer {sessionKey}on subsequent calls, with the session key expiring over time). Nango uses the simpler Basic-auth-on-every-request pattern, so there is no session to refresh. - The base URL is tenant-specific:
https://ctms.contingenttalentmanagement.com/{site-name}/clearConnect. The site name comes from the customer’s own ClearConnect base URL and is not discoverable through the API itself. The2_0API version segment isn’t part of the base URL — include it in each endpoint call (/2_0/index.cfm). - Some functions are Module Functions, only available to CTM customers who have purchased or enabled a specific module (e.g. Booking Region, PeopleSoft, Single Worker Portal). Calling one without the module enabled returns an error indicating the required module must be enabled.
get*actions have per-function record limits;insert*actions are capped at 200 records per batch/call.- String and numeric list arguments (e.g.
statusIn,tempIdIn) are comma-delimited strings, not JSON arrays, and are always returned as strings even for numeric lists.
Contribute API gotchas by editing this page