# Lucca Directory-v3 API

> Lucca Directory-v3 API on Apizie: 4 endpoints (List Users, Create a new User, Get a User by Id, Update a User by id) 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/business:lucca-directory/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:lucca-directory`
- Category: Business
- Status: byok
- Source: https://lucca-hr.com
- Page: https://zieapi.vercel.app/api/business/lucca-directory
- OpenAPI: https://zieapi.vercel.app/api/business/lucca-directory/openapi.json

Welcome on the documentation for the Directory v3 API.

## Endpoints

### List Users
`GET https://zieapi.vercel.app/v1/business:lucca-directory/users-list-excluded-former` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dtContractEnd | string | no | `{comparator},{date-time}`. |
| dtContractStart | string | no | {comparator},{date-time} |
| id | array | no | User's identifier |
| modifiedAt | string | no | {comparator},{date-time} |
| paging | string | no | {offset},{limit}. Defaults to 0,1000. |
| fields | array | no |  |
| mail | string | no | User's mail |
| login | string | no | User's login |

### Create a new User
`POST https://zieapi.vercel.app/v1/business:lucca-directory/users-create-new-user` (byok)

### Get a User by Id
`GET https://zieapi.vercel.app/v1/business:lucca-directory/users-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes |  |
| fields | array | no | Comma-separated list of fields of the user to include in responses. Extended data can be retrieved with `?fields=extendedData`. |

### Update a User by id
`POST https://zieapi.vercel.app/v1/business:lucca-directory/users-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes |  |
| fields | array | no | Fields of the user, comma separated |
| body | object | no | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/business:lucca-directory/users-list-excluded-former" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Lucca Directory-v3 API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/business:lucca-directory/users-list-excluded-former with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Lucca Directory-v3 API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Lucca Directory-v3 itself also needs your own key from example.ilucca.net.

### Can AI agents use the Lucca Directory-v3 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 business:lucca-directory.

### What is the status of the Lucca Directory-v3 API?
Needs your own provider key (bring your own key)