Sign in

v1

latestOpenAPI 3.0.02026-08-066425196.1 KB
Partner

Search for partners

Allows users to search for partners via userId , partner name, partnerNameId or all

get/partners/search

Query parameters

partnerNameIdstring

partnerNameId of the partner being searched

fullNamestring

Full name of the partner being searched

userIdstring

userId of the user that associated with the partner

Response

List of the partners retrieved through the search criteria.

partnerNameIdstring uuid

The unique identifier of the partner.

userIdstring uuid

The Id of the partner.

statusstring

The current status of the partner. Default is set to active.

fullNamestring

The full name of the partner.

Example response

{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa",
  "status": "ACTIVE",
  "fullName": "Demo Partner"
}