---
name: developer-documentation
description: "Developer documentation API skill. Use when working with Developer documentation for link, events, users. Covers 26 endpoints."
version: 1.0.0
generator: lapsh
---

# Developer documentation
API version: 1.0.0

## Auth
ApiKey (inferred from docs)

## Base URL
https://api.journy.io

## Setup
1. Set your API key in the appropriate header
2. GET /events -- get events
3. POST /link -- create first link

## Endpoints
26 endpoints across 10 groups. See references/api-spec.lap for full details.

### Link
| Method | Path | Description |
|--------|------|-------------|
| POST | /link | Link web activity to user |

### Events
| Method | Path | Description |
|--------|------|-------------|
| POST | /events | Track event |
| GET | /events | Get events |

### Users
| Method | Path | Description |
|--------|------|-------------|
| POST | /users/upsert | Create or update user |
| DELETE | /users | Delete user |

### Accounts
| Method | Path | Description |
|--------|------|-------------|
| POST | /accounts/upsert | Create or update account |
| POST | /accounts/users/add | Add users to an account |
| POST | /accounts/users/remove | Remove user from account |
| DELETE | /accounts | Delete account |

### Properties
| Method | Path | Description |
|--------|------|-------------|
| GET | /properties/users | Get user properties |
| GET | /properties/accounts | Get account properties |

### Validate
| Method | Path | Description |
|--------|------|-------------|
| GET | /validate | Validate API key |

### Tracking
| Method | Path | Description |
|--------|------|-------------|
| GET | /tracking/snippet | Get snippet for a website |

### Track
| Method | Path | Description |
|--------|------|-------------|
| POST | /track | Track event |

### Segments
| Method | Path | Description |
|--------|------|-------------|
| GET | /segments/users | Get user segments |
| GET | /segments/accounts | Get account segments |

### In-app-messages
| Method | Path | Description |
|--------|------|-------------|
| GET | /in-app-messages | List in-app messages |
| POST | /in-app-messages | Create in-app message |
| GET | /in-app-messages/user/{userId} | Get in-app messages for user |
| GET | /in-app-messages/user/{userId}/unread | Get unread in-app messages for user |
| GET | /in-app-messages/user/{userId}/new | Get new in-app messages for user |
| GET | /in-app-messages/account/{accountId} | Get in-app messages for account |
| GET | /in-app-messages/account/{accountId}/unread | Get unread in-app messages for account |
| GET | /in-app-messages/account/{accountId}/new | Get new in-app messages for account |
| PUT | /in-app-messages/{messageId}/received | Mark message as received |
| DELETE | /in-app-messages/{messageId} | Delete in-app message |

## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a link?" -> POST /link
- "Create a event?" -> POST /events
- "List all events?" -> GET /events
- "Create a upsert?" -> POST /users/upsert
- "Create a add?" -> POST /accounts/users/add
- "Create a remove?" -> POST /accounts/users/remove
- "List all users?" -> GET /properties/users
- "List all accounts?" -> GET /properties/accounts
- "List all validate?" -> GET /validate
- "List all snippet?" -> GET /tracking/snippet
- "Create a track?" -> POST /track
- "List all in-app-messages?" -> GET /in-app-messages
- "Create a in-app-message?" -> POST /in-app-messages
- "Get user details?" -> GET /in-app-messages/user/{userId}
- "List all unread?" -> GET /in-app-messages/user/{userId}/unread
- "List all new?" -> GET /in-app-messages/user/{userId}/new
- "Get account details?" -> GET /in-app-messages/account/{accountId}
- "Delete a in-app-message?" -> DELETE /in-app-messages/{messageId}
- "How to authenticate?" -> See Auth section above

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Paginated endpoints accept limit/offset or cursor parameters
- Create/update endpoints return the modified resource on success
- Error responses include status codes and descriptions in the spec

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)