canonical: https://jentic.com/apis/swaggerhub.tmforum-open-api/customer-management

# Tmforum Open Api Customer Management

This is Swagger UI environment generated for the TMF Customer Management specification. The API exposes 7 endpoints.

## For AI agents

Programmatically creates a 'customer', list or find 'customer' objects. Covers 7 operations.

## Scope

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

## Capabilities

- Creates a 'Customer'
- List or find 'Customer' objects
- Retrieves a 'Customer' by Id
- Updates partially a 'Customer' by Id
- Deletes a 'Customer' by Id
- Register a listener
- Unregister a listener

## Use cases

### Developer Tools Operations

Use the Customer Management to perform developer tools operations programmatically. The API provides 7 endpoints covering core functionality including creates a 'customer', list or find 'customer' objects, retrieves a 'customer' by id.

Example prompt: Call POST /customer to creates a 'customer'

### Automated customer Management

Automate customer operations by combining multiple Customer Management endpoints. Agents can list or find 'customer' objects and then retrieves a 'customer' by id in a single workflow.

Example prompt: Call GET /customer to list or find 'customer' objects, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Customer Management 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 none tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/customer` | Creates a 'Customer' |
| GET | `/customer` | List or find 'Customer' objects |
| GET | `/customer/{id}` | Retrieves a 'Customer' by Id |
| PATCH | `/customer/{id}` | Updates partially a 'Customer' by Id |
| DELETE | `/customer/{id}` | Deletes a 'Customer' by Id |
| POST | `/hub` | Register a listener |
| DELETE | `/hub/{id}` | Unregister a listener |

## Key resources

- **customer** — Operations related to customer
- **events subscription** — Operations related to events subscription

## Why Jentic

- **Setup:** Wiring the TMF Customer Management API by hand means pointing at its Orange Labs host, handling the customer and event hub endpoints, and building your own retries even though it exposes no auth scheme. Through Jentic you install once, import Customer Management from the API Directory, store the connection details once, and your agent calls it.
- **Permission scoping:** This API puts the customer id in the URL path (`/customer/{id}`), so a rule can pin your agent to one customer: it can read and update that record and nothing else. You choose the operations it may call, so destructive ones like deleting a customer or removing a hub subscription are not included unless you add them.
- **Credential handling:** Any connection details for Customer Management 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 'create a customer' or 'update a customer record', and Jentic returns the matching Customer Management operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Customer Management use?

The Customer Management uses no authentication. 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 creates a 'customer' with the Customer Management?

Yes. Use the POST /customer endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Customer Management?

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 creates a 'customer' through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'creates a 'customer''. Jentic returns the matching Customer Management operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Customer Management have?

The Customer Management exposes 7 endpoints covering customer, events subscription operations.

### Can I limit what my agent is allowed to do with the Customer Management API?

Yes. Because you run Jentic One yourself, your own rules decide which of the seven operations the agent may call and which connection details it uses. Since the customer id sits in the URL path (`/customer/{id}`), you can pin the agent to one customer so it only reads and patches that record and cannot touch others. Destructive operations such as DELETE `/customer/{id}` or unregistering a hub listener stay out of reach unless you explicitly grant them.
