37 lines
1.5 KiB
YAML
37 lines
1.5 KiB
YAML
get:
|
|
tags: [Recipients]
|
|
summary: List recipients
|
|
description: |
|
|
Returns recipients for the specified organization context.
|
|
Supports offset pagination and optional archive filtering.
|
|
The route currently includes both `org_ref` and `organizations_ref`; the handler resolves organization context from `org_ref` and ignores `organizations_ref`.
|
|
operationId: recipientsList
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- $ref: ../parameters/org_ref.yaml#/components/parameters/OrgRef
|
|
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
|
|
- $ref: ../parameters/limit.yaml#/components/parameters/Limit
|
|
- $ref: ../parameters/offset.yaml#/components/parameters/Offset
|
|
- $ref: ../parameters/archived.yaml#/components/parameters/Archived
|
|
responses:
|
|
'200':
|
|
description: Recipient list
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
|
|
- type: object
|
|
properties:
|
|
data:
|
|
$ref: ./response/recipient.yaml#/components/schemas/RecipientsAuthData
|
|
'400':
|
|
$ref: ../response/operation.yaml#/components/responses/BadRequest
|
|
'401':
|
|
$ref: ../response/operation.yaml#/components/responses/Unauthorized
|
|
'403':
|
|
$ref: ../response/operation.yaml#/components/responses/Forbidden
|
|
'500':
|
|
$ref: ../response/operation.yaml#/components/responses/InternalServerError
|