keitaro-api-skill/references/paths/streams_search.yaml

45 lines
1.0 KiB
YAML

get:
tags:
- Flows (Streams)
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
description: Search query
required: true
schema:
type: string
summary: Search in flows
description: Searching in flows
responses:
'200':
description: List of results
content:
application/json:
schema:
type: array
items:
$ref: ../schemas/Stream.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'500':
$ref: ../responses/InternalError.yaml
x-code-samples:
- lang: PHP
source: >
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,
'http://example.com/admin_api/v1/streams/search?query=string');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Api-Key: your-api-key'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);