Lap-Platform agentOS API V3, Diary Call Group
API version: v3-diary
Auth
basic | ApiKey ApiKey in header
Base URL
Setup
- Set your API key in the appropriate header
- GET /v3/diary/{shortname}/{branchID}/guest/search -- verify access
- POST /v3/diary/{shortName}/appointment -- create first appointment
Endpoints
13 endpoints across 1 groups. See references/api-spec.lap for full details.
diary
| Method | Path | Description |
|---|---|---|
| GET | /v3/diary/{shortname}/{branchID}/guest/search | Match Guest Parameters with existing applicants |
| GET | /v3/diary/{shortName}/allocations | Get a list of all available allocations for a date + 7 days for a specified appointment type |
| GET | /v3/diary/{shortName}/appointment | Get an appointment by ID |
| PUT | /v3/diary/{shortName}/appointment | Update an existing appointment using its unique identifier |
| POST | /v3/diary/{shortName}/appointment | Post an appointment into a valid diary allocation |
| DELETE | /v3/diary/{shortName}/appointment | Delete an existing appointment using its unique identifier |
| PATCH | /v3/diary/{shortName}/appointment/{appointmentID}/cancel | Cancel an existing appointment using its unique identifier |
| POST | /v3/diary/{shortName}/appointment/feedback | Submit appointment feedback |
| GET | /v3/diary/{shortName}/appointmentsbetweendates | A collection of diary appointments linked to a company filtered between specific dates and by appointment type |
| GET | /v3/diary/{shortName}/appointmenttypes | A collection of all diary appointment types |
| GET | /v3/diary/{shortName}/company/branches | All branches defined for a company |
| GET | /v3/diary/{shortName}/company/branches/{branchID} | Get a specific branch given its unique Object ID (OID) |
| GET | /v3/diary/{shortName}/recurringappointment | Retrieves all recurring appointments:- |
Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all search?" -> GET /v3/diary/{shortname}/{branchID}/guest/search
- "List all allocations?" -> GET /v3/diary/{shortName}/allocations
- "List all appointment?" -> GET /v3/diary/{shortName}/appointment
- "Create a appointment?" -> POST /v3/diary/{shortName}/appointment
- "Create a feedback?" -> POST /v3/diary/{shortName}/appointment/feedback
- "List all appointmentsbetweendates?" -> GET /v3/diary/{shortName}/appointmentsbetweendates
- "List all appointmenttypes?" -> GET /v3/diary/{shortName}/appointmenttypes
- "List all branches?" -> GET /v3/diary/{shortName}/company/branches
- "Get branche details?" -> GET /v3/diary/{shortName}/company/branches/{branchID}
- "List all recurringappointment?" -> GET /v3/diary/{shortName}/recurringappointment
- "How to authenticate?" -> See Auth section
Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object
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