canonical: https://jentic.com/apis/synchroteam.com/synchroteam

# Synchroteam API

Field service management API for jobs, customers, sites, equipment, invoices, users, teams and parts. The API exposes 58 endpoints secured with basic authentication.

## For AI agents

Programmatically get customer, create/update customer. Covers 58 operations with basic authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Get customer
- Create/update customer
- Delete customer
- Undelete customer
- List customers
- Activate customer
- Deactivate customer

## Use cases

### 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: Search Jentic for 'get customer', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| 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 |

## Key resources

- **Activities** — Operations related to Activities
- **Activity Types** — Operations related to Activity Types
- **Custom Fields** — Operations related to Custom Fields
- **Customers** — Operations related to Customers
- **Equipment** — Operations related to Equipment

## Why Jentic

- **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 handling:** 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.
- **Discovery method:** 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

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### 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.