Sign in
latestOpenAPI 3.0.32026-08-10362374.4 KB

98c494325aae

Recipient

Search Recipients

Returns the organizations Recipients in paginated format. The pagination is handled with the startIndex and length keys in the request body. There is one filtering option within the body:

  • searchTerm field is searched within the names and emails of the Recipients
post/recipient/search

Headers

api-versionstring required

The API version. Current version is 3.3. This value has to be set in every request.

Request body

startIndexinteger

Start index for pagination

lengthinteger

Number of results to return

searchTermstring

Search term to filter results

Response

Successful response

messagestring nullable
hasErrorboolean
validationErrorsstring[]
{"stackTrail":"components:schemas:ApiResponse:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","nullable":true}