Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tackle.io Referrals API

Create, read, update, and list events on Microsoft Partner Center co-sell referrals (both outbound and inbound).

Tackle.io Referrals API is one of 28 APIs that Tackle.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Referrals. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 4 operations across 3 paths, and defines 23 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://contracts.tackle.io.

4 operations 3 paths 23 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.tackle.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Tackle.io Referrals API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (tackleJwt). By default, every request must be authenticated.

  • tackleJwt — Tackle-issued JWT (interactive user or MTM token).

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Referrals 4

Create, read, update, and list events on Microsoft Partner Center co-sell referrals (both outbound and inbound).

POST
/api/referrals
Create a referral
createIPReferral 1 param body → 202400401403409500
GET
/api/referrals/{referral_id}
Get a referral
getReferral 1 param → 200401403404500
POST
/api/referrals/{referral_id}
Update a referral
updateIPReferral 2 params body → 202400401403404409500
GET
/api/referrals/{referral_id}/events
List referral events
listReferralEvents 2 params → 200401403500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Referral (43 properties), ReferralMetadata (21 properties), CreateReferralInput (12 properties), ListReferralEvent (10 properties). Each schema is shown below with its type and property counts.

TrackingInfo
object
Microsoft Partner Center tracking identifiers attached to the referral. Most fields are populated by Microsoft and reflect upstream tracking state; expect any…
7 properties
Link
object
HATEOAS-style link surfaced by Microsoft Partner Center for follow-up navigation. Useful when integrating the Microsoft Partner Center UI side-by-side with a T…
2 properties
SolutionInput
object
8 properties 5 required
AddressInput
object
Customer address used when creating a referral.
5 properties 2 required
InviteContextInput
object
Information supplied when inviting another organization into a co-sell engagement. Each entry in inviteContexts invites one organization (Microsoft or a partne…
9 properties 4 required
StatusChangedInput
object
4 properties
Error
object
Standard error envelope returned by this API. The message field is included for most 4xx responses raised by request validation. For 401, 403, and 500 response…
1 property
CustomerProfileInput
object
Customer contact information. Required.
6 properties 3 required
MemberInput
object
Person on the customer or partner side participating in the engagement (a salesperson, technical contact, or executive sponsor).
4 properties
ReferralMetadata
object
Tackle-side metadata layered onto a referral when returned by getReferral. Includes Tackle's stable identifier, CRM linkage state, and sync health signals.
21 properties 4 required
ConsentUpdateInput
object
Consent flags around sharing information with other organizations and allowing them to contact users. Required.
1 property
CreateReferralInput
object
12 properties 7 required
UpdateReferralInput
object
7 properties 1 required
DetailsInput
object
Customer details, notes, deal value, currency closing date. Required.
5 properties 3 required
DetailsUpdateInput
object
Customer details, notes, deal value, currency closing date. Required.
5 properties
ConsentInput
object
Consent flags around sharing information with other organizations and allowing them to contact users. Required.
4 properties 3 required
Target
object
Sales target attached to the referral, identifying which solution profile or business profile location the referral is aimed at.
2 properties
ListReferralEvent
object
10 properties 3 required
RequirementsInput
object
Industry, products, service type, and solutions the customer is interested in.
4 properties 1 required
InviteContext
object
Read-side representation of the invite context returned on a referral. The shape differs from the request-side InviteContextInput: the inviting organization is…
4 properties
Referral
object
Read-side representation of a co-sell referral as returned by getReferral and listReferralEvents. Fields are populated from Microsoft Partner Center; null or o…
43 properties
RequirementsUpdateInput
object
Industry, products, service type, and solutions the customer is interested in.
2 properties
ReferralResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tackleio-referrals-api-openapi.yml Raw ↑

Other APIs Tackle.io publishes across the network.

Tackle.io Authentication API
Tackle.io Contracts API
Tackle.io Currencies API
Tackle.io Customers API
Tackle.io Disbursements API
Tackle.io Entitlements API
Tackle.io Groups API
Tackle.io Invitations API
Tackle.io Invoices API
Tackle.io Marketplace API
Tackle.io Metering API
Tackle.io Notifications API