# agentOS Api V2, Customer Login Call Group API

> agentOS Api V2, Customer Login Call Group API on Apizie: 24 endpoints (All branches defined for a company, Get a specific branch given its unique Object ID (OID), Get the accounting details for the landlord., Download a Document, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/ecommerce:letmc-customer/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:letmc-customer`
- Category: E-commerce
- Status: byok
- Source: https://letmc.com
- Page: https://zieapi.vercel.app/api/ecommerce/letmc-customer
- OpenAPI: https://zieapi.vercel.app/api/ecommerce/letmc-customer/openapi.json



## Endpoints

### All branches defined for a company
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/branch-controller-get-branches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| offset | integer | yes | The index of the first item to return |
| count | integer | yes | The maximum number of items to return (up to 1000 per request) |

### Get a specific branch given its unique Object ID (OID)
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/get-v2-customer-short-name-branch-branches-branch-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| branchID | string | yes | The unique ID of the Branch |

### Get the accounting details for the landlord.
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |

### Download a Document
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| ID | string | yes | The Document ID |

### Generate a Inventory PDF for a tenancy
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-invetory-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| tenancyID | string | yes | The Tenancy ID |

### Get an invoice pdf belonging to the landlord.
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| invoiceID | string | yes | The invoice ID to load. |

### Retrieve landlord's CRM ID
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-landlord-crm-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |

### Get Active maintenance jobs.
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-maintenance-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |

### Generate a Profit and Loss Report
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-profit-loss-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |

### Rent Arrears
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-rent-arrears` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |

### Generate a Self Assessment Tax Report
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-sasreport` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| yearEnd | integer | yes | The Tax Year End. |

### Get contact details of all linked landlords.
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |

### Get the summary details for the landlord.
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-summary-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |

### Get tenancy details.
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-tenancy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| tenancyID | string | yes | The Tenancy ID |

### Post tenancy maintenance preferences:-
`POST https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-create-maintenance-preference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| tenancyID | string | yes | The Tenancy ID |
| name | string | yes | Name of the maintenance preference to add |
| notes | string | yes | Notes of the maintenance preference to add |

### Generate a Tenancy Agreement Copy (PDF)
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/landlord-controller-get-tenancy-agreement-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| tenancyID | string | yes | The Tenancy ID |

### Downloads the photo of a property given the photo ID.
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/photo-controller-get-photo-download` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| photoID | string | yes | The unique ID of the photo on the property |
| width | integer | no | An optional parameter specifying the image width |
| height | integer | no | An optional parameter specifying the image height |

### A collection showing all the photos linked to a specific block, property or room
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/property-controller-get-properties-photos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| propertyID | string | yes | The unique ID of the Property |
| offset | integer | yes | The index of the first item to return |
| count | integer | yes | The maximum number of items to return (up to 1000 per request) |

### Gets information about the currently logged on customer.
`GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/session-controller-get-session-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |

### Login as a customer given their username and password.
`POST https://zieapi.vercel.app/v1/ecommerce:letmc-customer/session-controller-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| username | string | yes | The user's username. |
| password | string | yes | The user's password. |

### Logout a customer previously logged in via the Login endpoint.
`POST https://zieapi.vercel.app/v1/ecommerce:letmc-customer/session-controller-logout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |

### Send a request to the in-tray to create a landlord login.
`POST https://zieapi.vercel.app/v1/ecommerce:letmc-customer/session-controller-create-landlord-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| email | string | yes | The email address of the landlord |
| title | string | yes | The title of the landlord |
| forename | string | yes | The forename of the landlord |
| surname | string | yes | The surname of the landlord |
| propertyAddress | string | yes | Address of the property linked to the landlord |
| contactDetails | string | yes | Contact details of the landlord |
| branchID | string | no | (Optional) The branch ID linked to the login. This will determine which in tray the request display in |

### Change the password of a customer given their existing and new password.
`POST https://zieapi.vercel.app/v1/ecommerce:letmc-customer/session-controller-change-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| token | string | yes | The login token returned from the /session POST call |
| oldPassword | string | yes | The customer's existing password. |
| newPassword | string | yes | The customer's new password. |

### Reset the customer's password. An email will be sent out to reset.
`POST https://zieapi.vercel.app/v1/ecommerce:letmc-customer/session-controller-reset-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shortName | string | yes | The unique client short-name |
| email | string | yes | The login Email Address. |

## Example
```
curl "https://zieapi.vercel.app/v1/ecommerce:letmc-customer/branch-controller-get-branches" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the agentOS Api V2, Customer Login Call Group API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/ecommerce:letmc-customer/branch-controller-get-branches with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the agentOS Api V2, Customer Login Call Group API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. agentOS Api V2, Customer Login Call Group itself also needs your own key from letmc.com.

### Can AI agents use the agentOS Api V2, Customer Login Call Group API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:letmc-customer.

### What is the status of the agentOS Api V2, Customer Login Call Group API?
Needs your own provider key (bring your own key)