48 lines
1.2 KiB
Markdown
48 lines
1.2 KiB
Markdown
---
|
|
name: directories-routes
|
|
description: Handle 3 OpenAPI operation(s) under /directories for the directories route group.
|
|
---
|
|
|
|
# directories API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /directories for the directories route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### directories_controller_list
|
|
|
|
- Operation ID: `directories_controller_list`
|
|
- Route: `GET /directories`
|
|
- Mode: READ
|
|
- Summary: List Directories
|
|
- Parameters:
|
|
- `before` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `order` in `query`
|
|
- `organization_id` in `query`
|
|
- `search` in `query`
|
|
- `domain` in `query`
|
|
|
|
### directories_controller_find
|
|
|
|
- Operation ID: `directories_controller_find`
|
|
- Route: `GET /directories/{id}`
|
|
- Mode: READ
|
|
- Summary: Get a Directory
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### directories_controller_delete_directory
|
|
|
|
- Operation ID: `directories_controller_delete_directory`
|
|
- Route: `DELETE /directories/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a Directory
|
|
- Parameters:
|
|
- `id` in `path` required
|