# Developer documentation API

> Developer documentation API on Apizie: 15 endpoints (Delete account, Create or update account, Add users to an account, Remove user from account, …) returned as clean JSON through one API key. 15 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/business:journy/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:journy`
- Category: Business
- Status: live
- Source: https://developers.journy.io
- Page: https://zieapi.vercel.app/api/business/journy
- OpenAPI: https://zieapi.vercel.app/api/business/journy/openapi.json

# Welcome Implementing a new tool can be daunting, but it doesn't have to. You can implement journy.io in a few different ways to ensure it fits with the rest of your tech stack seamlessly. We welcome your feedback,…

## Endpoints

### Delete account
`POST https://zieapi.vercel.app/v1/business:journy/delete-account`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Create or update account
`POST https://zieapi.vercel.app/v1/business:journy/upsert-account`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Add users to an account
`POST https://zieapi.vercel.app/v1/business:journy/add-user-to-account`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Remove user from account
`POST https://zieapi.vercel.app/v1/business:journy/remove-user-from-account`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get events
`GET https://zieapi.vercel.app/v1/business:journy/get-events`

### Link web activity to user
`POST https://zieapi.vercel.app/v1/business:journy/link`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get account properties
`GET https://zieapi.vercel.app/v1/business:journy/get-account-properties`

### Get user properties
`GET https://zieapi.vercel.app/v1/business:journy/get-user-properties`

### Get account segments
`GET https://zieapi.vercel.app/v1/business:journy/get-account-segments`

### Get user segments
`GET https://zieapi.vercel.app/v1/business:journy/get-user-segments`

### Track event
`POST https://zieapi.vercel.app/v1/business:journy/track-event`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get snippet for a website
`GET https://zieapi.vercel.app/v1/business:journy/get-tracking-snippet`

| Parameter | Type | Required | Description |
|---|---|---|---|
| domain | string | yes | The domain you want to receive a snippet for |

### Delete user
`POST https://zieapi.vercel.app/v1/business:journy/delete-user`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Create or update user
`POST https://zieapi.vercel.app/v1/business:journy/upsert-user`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Validate API key
`GET https://zieapi.vercel.app/v1/business:journy/get-validity`

## Example
```
curl "https://zieapi.vercel.app/v1/business:journy/delete-account" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Developer documentation API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/business:journy/delete-account with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Developer documentation API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Developer documentation 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:journy.

### What is the status of the Developer documentation API?
Live: works with just an Apizie key