Synchroteam API
42
AI ReadinessFoundational (D-)42/100
Official vendor OpenAPI document · agent-readyPaymentsBilling Subscriptionsbasic58 EndpointsREST
For Agents
Programmatically get customer, create/update customer. Covers 58 operations with basic authentication.
Use for: I need to customer, I want to create/update customer, Search for customer, Find all undelete customer
Not supported: Does not handle communications, crm, or developer tools - use for payments only.
Field service management API for jobs, customers, sites, equipment, invoices, users, teams and parts. The API exposes 58 endpoints secured with basic authentication.
Install Jentic One Beta
Connect the Synchroteam API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Synchroteam API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fsynchroteam.com%2Fsynchroteam" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fsynchroteam.com%2Fsynchroteam" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Synchroteam API.
Get customer
Create/update customer
Delete customer
Undelete customer
List customers
Activate customer
Deactivate customer
Use Cases
Patterns agents use Synchroteam API for, with concrete tasks.
★ Payments Operations
Use the Synchroteam API to perform payments operations programmatically. The API provides 58 endpoints covering core functionality including get customer, create/update customer, delete customer.
Call GET /customer/details to get customer
Automated Activities Management
Automate activities operations by combining multiple Synchroteam API endpoints. Agents can create/update customer and then delete customer in a single workflow.
Call POST /customer/send to create/update customer, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Synchroteam API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.
Search Jentic for 'get customer', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
58 endpoints — field service management api for jobs, customers, sites, equipment, invoices, users, teams and parts.
METHOD
PATH
DESCRIPTION
GET
/customer/details
Get customer
POST
/customer/send
Create/update customer
DELETE
/customer/delete
Delete customer
POST
/customer/undelete
Undelete customer
GET
/customer/list
List customers
POST
/customer/activate
Activate customer
POST
/customer/desactivate
Deactivate customer
GET
/job/details
Get job
GET
/customer/details
Get customer
POST
/customer/send
Create/update customer
DELETE
/customer/delete
Delete customer
POST
/customer/undelete
Undelete customer
GET
/customer/list
List customers
POST
/customer/activate
Activate customer
POST
/customer/desactivate
Deactivate customer
GET
/job/details
Get job
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
S
Synchroteam API
- Foundational (D-)42/100
99
Foundational Compliance63
Developer Experience & Jentic Compatibility56
AI-Readiness & Agent Experience93
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
97%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
56
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
76%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
93
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
93%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Synchroteam API by hand means base64-encoding your domain and API key for basic auth, pointing at the ws.synchroteam.com host, and shaping the customer and job requests yourself. Through Jentic you install once, import Synchroteam from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
Synchroteam identifies the customer and job by id in the request parameters rather than the URL path, so scope the agent to the operations it needs, such as reading customer details or listing customers. You choose that allowed set, so destructive ones like deleting or deactivating a customer stay out of reach unless you add them.
Credential isolation
Your Synchroteam credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'get customer details' or 'list customers', and Jentic returns the matching Synchroteam operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe
Alternative payments API
Choose Stripe when you need a different approach to payments operations
FAQs
Specific to using Synchroteam API through Jentic.
What authentication does the Synchroteam API use?
The Synchroteam API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I get customer with the Synchroteam API?
Yes. Use the GET /customer/details endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Synchroteam API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I get customer through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get customer'. Jentic returns the matching Synchroteam API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Synchroteam API have?
The Synchroteam API exposes 58 endpoints covering activities, activity types, custom fields operations.
Can I limit what my agent is allowed to do with the Synchroteam API?
Yes. Because you run Jentic One yourself, your own rules decide which Synchroteam operations and credentials the agent may use, so you can allow read-only calls like getting customer details or listing customers while keeping everything else off limits. Since Synchroteam identifies each customer and job by id in the request parameters rather than the URL path, you scope the agent to the specific operations it needs. Destructive calls such as deleting or deactivating a customer stay out of reach unless you explicitly add them to the allowed set.
GET STARTED