Sign in
latestOpenAPI 3.0.32026-08-10362374.4 KB

98c494325aae

Credential

Search Credentials

Returns the organizations Credentials in paginated format. The pagination is handled with the startIndex and length keys in the request body. There are three filtering options within the body:

  • searchTerm field is searched within the name and emails of the Credentials
  • campaignIds field is a string array used for filtering the Credentials which belong to the given Campaigns
  • recipientIds field is a string array used for filtering the Credentials which belong to the given Recipients
post/credential/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
lengthinteger
statusinteger
campaignIdsstring[]

Filter by Campaign IDs

recipientIdsstring[]

Filter by Recipient IDs

searchTermstring

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}