Search partners

Return the partners matching a filter, with the total number of matches.

A filter has two levels. The entries of and are combined with and, and an entry is either a single condition or an or group of conditions. A group holds conditions only, so there is no third level. A filter carries at most 20 conditions in total, and a larger request is refused rather than trimmed.

A condition names a field, an operator and a value. Set isCustomProperty to true when the name is one of the workspace’s own partner properties: static fields and custom properties are separate sets, so the same name can exist in both. Names are matched without regard to case.

Operators

Operator	Value
Eq, Neq	a single value
In, Nin	an array of values, which must not be empty
Contains, NotContains	a text value matched as a substring
Gt, Gte, Lt, Lte	a single value
Between	an object holding from and to, both included
Empty, NotEmpty	no value at all

Fields

Field	Type	Operators
name	text	Eq, Neq, In, Contains, NotContains
status	Active, Prospect, Rejected, Applicant, Inactive, Onboarding	Eq, Neq, In, Nin
onboardingStatus	NotOnboarded, InProgress, Completed	Eq, Neq, In, Nin
source	ManuallyAdded, SignupForm	Eq, Neq, In, Nin
partnerTypeId	number	Eq, Neq, In, Nin
groupId	number	Eq, Neq, In, Nin, Empty, NotEmpty
referralCode	text	Eq, Neq, In
currency	text	Eq, Neq, In
language	text	Eq, Neq, In
sinceDate	date	Eq, Neq, Gt, Gte, Lt, Lte, Between, Empty, NotEmpty
creationDate	date	Eq, Neq, Gt, Gte, Lt, Lte, Between
mainContactEmail	text	Eq, Neq, In, Contains
programId	number	Eq, In, Nin
partnerLevelId	number	Eq, In, Nin
qualifyingLevelId	number	Eq, In, Nin
onboardingStageId	number	Eq, In, Nin
prospectionStageId	number	Eq, In, Nin, Empty, NotEmpty

A custom property accepts the operators that suit its own type. A date is written as an ISO 8601 string, for example 2025-01-31.

Refusals

Every condition is checked before any data is read, and a filter that cannot be applied refuses the whole request: no partner is returned. The metadata of the error lists one entry per problem under errors, each with the JSON path of the offending value, a code and a message. When a name was not recognised, metadata also lists the names that may be used under staticFields and customProperties.

POST /v3/partners/search

Search partners

cURL

curl --request POST \
  --url https://api.example.com/v3/partners/search \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "filters": {
    "and": [
      {
        "or": [
          {
            "field": "<string>",
            "isCustomProperty": true,
            "value": "<unknown>"
          }
        ],
        "field": "<string>",
        "isCustomProperty": true,
        "value": "<unknown>"
      }
    ]
  },
  "offset": 123,
  "limit": 123
}
'

200

{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "groupId": 123,
      "onboardingStatus": "Unknown",
      "status": "Unknown",
      "source": "Unknown",
      "company": {
        "id": 123,
        "name": "<string>",
        "websiteUrls": [
          "<string>"
        ]
      },
      "mainContact": {
        "id": 123,
        "email": "<string>",
        "firstname": "<string>",
        "lastname": "<string>",
        "jobTitle": "<string>",
        "phoneNumber": "<string>",
        "linkedInProfileUrl": "<string>",
        "creationDate": "2023-11-07T05:31:56Z",
        "isMainContact": true
      },
      "onboardingStage": {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "order": 123,
        "onboardingPipelineId": 123,
        "onboardingPipelineName": "<string>"
      },
      "onboardingStages": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "order": 123,
          "onboardingPipelineId": 123,
          "onboardingPipelineName": "<string>"
        }
      ],
      "levels": [
        {
          "programLevelId": 123,
          "programLevelName": "<string>",
          "programId": 123,
          "programName": "<string>"
        }
      ],
      "sinceDate": "2023-11-07T05:31:56Z",
      "partnerTypeId": 123,
      "partnerTypeName": "<string>",
      "properties": {},
      "ownerUserId": 123,
      "owner": {
        "id": 123,
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "referralCode": "<string>",
      "paypalEmail": "<string>",
      "currency": "<string>",
      "payoutProvider": {
        "type": "Unknown",
        "details": {}
      },
      "language": "<string>"
    }
  ],
  "paginationSkipCount": 123,
  "totalCount": 123
}

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

The body of a search: the filter to apply and where in the result set to read from.

filters · object

A filter of two levels.

Show child attributes

offset · integer<int32>

The cursor used in pagination.

limit · integer<int32>

The maximum number of items to be returned.

Response

200

application/json

Partners returned

items · object[] | null

Show child attributes

paginationSkipCount · integer<int32>

totalCount · integer<int32>

Gets or sets the total number of items that could be returned by this command (without pagination).