4.2 KiB
4.2 KiB
name, description
| name | description |
|---|---|
| lists-routes | Handle 13 OpenAPI operation(s) under /api/lists for the lists route group. |
lists API Routes
Handle 13 OpenAPI operation(s) under /api/lists for the lists 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
get_lists
- Operation ID:
get_lists - Route:
GET /api/lists - Mode: READ
- Summary: Get Lists
- Parameters:
fields[flow]inqueryfields[list]inqueryfields[tag]inqueryfilterinqueryincludeinquerypage[cursor]inquerypage[size]inquerysortinqueryrevisioninheaderrequired
create_list
- Operation ID:
create_list - Route:
POST /api/lists - Mode: WRITE
- Summary: Create List
- Parameters:
fields[list]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
get_list
- Operation ID:
get_list - Route:
GET /api/lists/{id} - Mode: READ
- Summary: Get List
- Parameters:
idinpathrequiredadditional-fields[list]inqueryfields[flow]inqueryfields[list]inqueryfields[tag]inqueryincludeinqueryrevisioninheaderrequired
update_list
- Operation ID:
update_list - Route:
PATCH /api/lists/{id} - Mode: WRITE
- Summary: Update List
- Parameters:
idinpathrequiredfields[list]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
delete_list
- Operation ID:
delete_list - Route:
DELETE /api/lists/{id} - Mode: WRITE
- Summary: Delete List
- Parameters:
idinpathrequiredrevisioninheaderrequired
get_tags_for_list
- Operation ID:
get_tags_for_list - Route:
GET /api/lists/{id}/tags - Mode: READ
- Summary: Get Tags for List
- Parameters:
idinpathrequiredfields[tag]inqueryrevisioninheaderrequired
get_tag_ids_for_list
- Operation ID:
get_tag_ids_for_list - Route:
GET /api/lists/{id}/relationships/tags - Mode: READ
- Summary: Get Tag IDs for List
- Parameters:
idinpathrequiredrevisioninheaderrequired
get_profiles_for_list
- Operation ID:
get_profiles_for_list - Route:
GET /api/lists/{id}/profiles - Mode: READ
- Summary: Get Profiles for List
- Parameters:
idinpathrequiredadditional-fields[profile]inqueryfields[profile]inqueryfilterinquerypage[cursor]inquerypage[size]inquerysortinqueryrevisioninheaderrequired
get_profile_ids_for_list
- Operation ID:
get_profile_ids_for_list - Route:
GET /api/lists/{id}/relationships/profiles - Mode: READ
- Summary: Get Profile IDs for List
- Parameters:
idinpathrequiredfilterinquerypage[cursor]inquerypage[size]inquerysortinqueryrevisioninheaderrequired
add_profiles_to_list
- Operation ID:
add_profiles_to_list - Route:
POST /api/lists/{id}/relationships/profiles - Mode: WRITE
- Summary: Add Profiles to List
- Parameters:
idinpathrequiredrevisioninheaderrequired
- Body: JSON request body accepted.
remove_profiles_from_list
- Operation ID:
remove_profiles_from_list - Route:
DELETE /api/lists/{id}/relationships/profiles - Mode: WRITE
- Summary: Remove Profiles from List
- Parameters:
idinpathrequiredrevisioninheaderrequired
- Body: JSON request body accepted.
get_flows_triggered_by_list
- Operation ID:
get_flows_triggered_by_list - Route:
GET /api/lists/{id}/flow-triggers - Mode: READ
- Summary: Get Flows Triggered by List
- Parameters:
idinpathrequiredfields[flow]inqueryrevisioninheaderrequired
get_ids_for_flows_triggered_by_list
- Operation ID:
get_ids_for_flows_triggered_by_list - Route:
GET /api/lists/{id}/relationships/flow-triggers - Mode: READ
- Summary: Get IDs for Flows Triggered by List
- Parameters:
idinpathrequiredrevisioninheaderrequired