List referrals

get

https://msft.cosell.tackle.io/api/referrals

Returns a paginated list of co-sell referrals for the authenticated vendor. Supports free-text search, multi-value filters, date ranges, and offset-based pagination. Set pageSize (1–100, default 10) and either omit from to start from the first record or set from to the nextIndex value from the previous page. The response's isNextPage indicates whether more results are available; nextIndex is only present when isNextPage is true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Free-text search across referral fields.

from

integer

Zero-based index to start pagination from.

pageSize

integer

Defaults to 10

Number of referrals to return per page (minimum 1, maximum 100, default 10).

sortField

string

enum

Field used to sort referrals.

sortOrder

string

enum

Defaults to asc

Sort direction. Defaults to asc.

Allowed:

cloudStatus

array of strings

Repeat to filter by one or more Microsoft referral statuses.

cloudStatus

cloudSubStatus

array of strings

Repeat to filter by one or more Microsoft referral sub-statuses.

cloudSubStatus

source

array of strings

Repeat to filter by one or more referral directions/sources.

source

crmId

array of strings

Repeat to filter by one or more CRM IDs.

crmId

isMaccEligible

array of strings

Repeat to filter by MACC eligibility.

isMaccEligible

customerIsManaged

string

enum

Filter by customer managed status. unknown returns referrals without a recorded managed status.

Allowed:

classification

array of strings

Repeat to filter by referral classification.

classification

dealType

array of strings

Repeat to filter by deal type.

dealType

solution

array of strings

Repeat to filter by one or more Microsoft solution IDs.

solution

country

array of strings

Repeat to filter by one or more ISO 3166-1 alpha-2 customer country codes.

country

state

array of strings

Repeat to filter by one or more customer state or province values from Microsoft. Use alongside country to avoid ambiguous names across countries.

state

hasCloudErrors

boolean

Filter by presence or absence of the cloud consecutive error counter (cloudConsecutiveErrorCount). When sent together with hasSalesforceErrors=true, matches referrals with either error type (logical OR).

hasSalesforceErrors

boolean

Filter by presence or absence of the Salesforce consecutive error counter (salesforceConsecutiveError). When sent together with hasCloudErrors=true, matches referrals with either error type (logical OR).

hasAnyError

boolean

Filter by presence or absence of cloud and/or Salesforce sync error signals.

hasCrmId

boolean

Filter by presence or absence of a CRM ID.

startTargetCloseDate

date

Inclusive lower bound for target close date.

endTargetCloseDate

date

Inclusive upper bound for target close date.

startCloudCreated

date

Inclusive lower bound for cloud created date.

endCloudCreated

date

Inclusive upper bound for cloud created date.

Response

Language

Credentials

Bearer

MTM JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200