# Kiflo ## Docs - [What Is Kiflo PRM? Platform Overview and Key Features](https://docs-vnext.kiflo.com/introduction.md): Discover what Kiflo is, who it's designed for, and how its capabilities — programs, portal, rewards, and integrations — power your partner program. - [Getting Started with Kiflo: Step-by-Step Setup Guide](https://docs-vnext.kiflo.com/getting-started.md): Follow these nine steps to configure your Kiflo account from scratch — from creating partner programs to connecting your CRM and going live. - [Kiflo Glossary: Definitions for All Platform Terms](https://docs-vnext.kiflo.com/glossary.md): A reference of every key term used in Kiflo — assets, programs, rewards, payouts, leads, deals, and more — so you always know what each concept means. - [Partner Programs in Kiflo: Overview and Key Concepts](https://docs-vnext.kiflo.com/programs/overview.md): Learn what partner programs are in Kiflo, how they differ from partner types, and what you can configure per program to power your ecosystem. - [Create a Partner Program: Step-by-Step Kiflo Guide](https://docs-vnext.kiflo.com/programs/create-program.md): Step-by-step guide to creating a new partner program in Kiflo and customising its emails, T&Cs, portal settings, and application form. - [Partner Types: Adding Granularity Within Your Programs](https://docs-vnext.kiflo.com/programs/partner-types.md): Understand how partner types differ from partner programs, and learn how to add, rename, remove, and reorder types in Account Settings. - [How to Invite Partners to Kiflo and the Partner Portal](https://docs-vnext.kiflo.com/partners/invite-partners.md): Create partner accounts in Kiflo, send invitations automatically or manually, impersonate partners to preview their portal, and accept applications. - [Partner Prospection: Building Your Partner Pipeline](https://docs-vnext.kiflo.com/partners/partner-prospection.md): Use Kiflo's prospection pipeline to track, qualify, and convert potential partners into active relationships before onboarding begins. - [Manage Partner Team Members, Contacts, and Portal Access](https://docs-vnext.kiflo.com/partners/manage-team-members.md): Add, remove, and manage the individual contacts within a partner organisation, control portal access, and let partners manage their own team. - [Kiflo Leads Overview: Types, Statuses, and Lifecycle](https://docs-vnext.kiflo.com/leads/overview.md): Learn what leads are in Kiflo, the difference between Shared and Submitted leads, and how to manage the full lead lifecycle from submission to conversion. - [Referral Links: Track and Manage Partner-Referred Leads](https://docs-vnext.kiflo.com/leads/referral-links.md): Set up partner-specific referral links, install the Kiflo tracking snippet, and manage referral codes to attribute leads automatically. - [Lead Forms: Customize, Share, and Validate Submissions](https://docs-vnext.kiflo.com/leads/lead-forms.md): Customize your lead submission form fields, share leads with partners, submit on their behalf, and configure auto-accept and conflict detection. - [Kiflo Deals Overview: Types, Statuses, and Lifecycle](https://docs-vnext.kiflo.com/deals/overview.md): Learn what deals are in Kiflo, how they differ from leads, and how the deal lifecycle moves from registration through to won or lost. - [Deal Registration: Forms, Approval, and Deal Settings](https://docs-vnext.kiflo.com/deals/deal-registration.md): Customize the deal registration form, configure approval workflows, enable line items, and control partner registration permissions per program. - [Deal Pipeline: Stages, Expiration, and Conflict Rules](https://docs-vnext.kiflo.com/deals/deal-pipeline.md): Customize deal pipeline stages, manage deal expiration, detect channel conflicts, and convert leads to deals with automatic value copying. - [Kiflo Rewards & Payouts: Overview and Full Workflow](https://docs-vnext.kiflo.com/rewards/overview.md): Learn how partner rewards accumulate, how payouts move from Draft to Paid, and how multi-currency and self-invoicing fit into the workflow. - [How to Create Partner Payouts in Kiflo: All Methods](https://docs-vnext.kiflo.com/rewards/create-payouts.md): Create payouts from the Partners tab, the Payouts tab, or a partner's Rewards tab — or automate payout creation on a monthly or quarterly schedule. - [Validate and Pay Partner Payouts in Kiflo: Full Guide](https://docs-vnext.kiflo.com/rewards/validate-pay.md): Review and approve rewards, collect partner confirmation, export payouts in XLSX or PayPal format, and mark payouts as paid when done. - [Kiflo Self-Invoicing for Partners: Setup and EU VAT](https://docs-vnext.kiflo.com/rewards/self-invoicing.md): Configure Kiflo to generate invoices on behalf of your partners automatically, including EU VAT handling and partner opt-in via the portal or onboarding. - [Kiflo Partner Portal: Capabilities and Setup Guide](https://docs-vnext.kiflo.com/partner-portal/overview.md): Learn what the Kiflo partner portal offers your partners and how to customize it with branding, dashboards, permissions, and terms and conditions. - [Set Up and Customize Partner Portal Branding Today](https://docs-vnext.kiflo.com/partner-portal/branding.md): Upload your logo, add a sign-in background image, and configure a custom domain to make the Kiflo partner portal reflect your brand. - [Configure and Preview Your Partner Portal Dashboards](https://docs-vnext.kiflo.com/partner-portal/partner-dashboard.md): Build widget-based dashboards that partners see on login, assign them to program tiers, and preview them as a specific partner to verify the experience. - [How to Build Partner Onboarding Pipelines in Kiflo](https://docs-vnext.kiflo.com/partner-portal/partner-onboarding.md): Create onboarding pipelines, set up stages and actions, start partners through the process, and track progress from a kanban board or partner page. - [Manage Partner Certifications, Status, and Renewals](https://docs-vnext.kiflo.com/partner-portal/certifications.md): Create certifications, assign them to partner team members, track validity status, and automatically notify partners before and when certifications expire. - [Partner Business Plans: Goals and Progress Tracking](https://docs-vnext.kiflo.com/partner-portal/business-plans.md): Build collaborative business plans with partners, define sales and marketing objectives, log activities, and monitor progress toward shared goals. - [Partner Assets: Upload, Organize, and Share Content](https://docs-vnext.kiflo.com/enablement/assets.md): Upload files, add URLs, and organize collateral in your Kiflo Assets library. Control which partners can see each asset by program, group, or individual. - [Partner Help Center: Build a Self-Service Knowledge](https://docs-vnext.kiflo.com/enablement/help-center.md): Build a self-service knowledge base in your partner portal with Collections, Articles, and FAQs so partners find answers without contacting your team. - [Partner Directories — Public Partner Listing Pages](https://docs-vnext.kiflo.com/enablement/partner-directories.md): Publish a branded public page listing your partners, with visitor search and filtering, individual profile pages, and automatic lead generation. - [Kiflo Workflows: Automate Your Partner Program Tasks](https://docs-vnext.kiflo.com/workflows/overview.md): Use Kiflo Workflows to automate email sequences, task creation, and partner alerts based on triggers like invitation status, metrics, or payout events. - [Workflow Triggers: All Events That Start Automations](https://docs-vnext.kiflo.com/workflows/triggers.md): Reference all Kiflo workflow triggers — invitation status, metric changes, partner properties, and payout validation — with setup steps and use cases. - [Workflow Actions, Enrollments, and Practical Examples](https://docs-vnext.kiflo.com/workflows/actions.md): Configure Send email, Create task, and Delay actions in Kiflo Workflows. Covers enrollment statuses, stopping workflows, and a welcome-sequence example. - [Integrations Overview — Connect Kiflo to Your Stack](https://docs-vnext.kiflo.com/integrations/overview.md): Browse every native integration available in Kiflo, organized by category — from CRM and payment tools to chat apps and website plugins. - [HubSpot Integration — Sync Partners and Deals to CRM](https://docs-vnext.kiflo.com/integrations/hubspot.md): Connect HubSpot to Kiflo for a bidirectional sync of partners, leads, deals, contacts, and notes — including deal stage and field mapping. - [Salesforce Integration — Sync Kiflo with Salesforce](https://docs-vnext.kiflo.com/integrations/salesforce.md): Connect Salesforce to Kiflo for a bidirectional sync of leads, deals, contacts, and partner data between your PRM and your CRM in real time. - [Stripe Integration — Automate Partner Transactions](https://docs-vnext.kiflo.com/integrations/stripe.md): Connect Stripe to Kiflo to automatically create transactions, convert leads to customers, and trigger partner rewards from Stripe payments. - [Zapier Integration — Automate Kiflo with 2,000+ Apps](https://docs-vnext.kiflo.com/integrations/zapier.md): Use Zapier to automate workflows between Kiflo and thousands of other apps — no code required. Great for CRM sync, partner marketing, and more. - [WordPress Integration — Track Referrals and Capture Leads](https://docs-vnext.kiflo.com/integrations/wordpress.md): Install the Kiflo WordPress plugin to track partner referral visits and capture leads or partner applications through your website forms. - [Account Settings Overview — Configure Your Kiflo Account](https://docs-vnext.kiflo.com/account/overview.md): Explore every configurable area of your Kiflo account — from currencies and domains to emails, security, team members, products, and properties. - [Email Settings — Sending Domain, Templates & Automation](https://docs-vnext.kiflo.com/account/email-settings.md): Configure your sending domain, sender address, email templates, automated program emails, acknowledgments, and per-language email delivery in Kiflo. - [Security Settings — API Tokens, SSO, and MFA in Kiflo](https://docs-vnext.kiflo.com/account/security.md): Generate and revoke API Access Tokens, configure Single Sign-On (SSO) for your team, and enable Multi-Factor Authentication to protect your Kiflo account. - [Team, Properties & Products — Manage Your Kiflo Workspace](https://docs-vnext.kiflo.com/account/team.md): Invite coworkers to Kiflo, assign roles, manage partner data visibility, customize properties, and configure products and prices for your programs. - [Kiflo REST API: Overview, Authentication, and URLs](https://docs-vnext.kiflo.com/developers/api-overview.md): Explore Kiflo's resource-oriented REST API: base URL, authentication, when to use the API versus the JS SDK, and links to the full reference. - [API Authentication: Generate and Manage Access Tokens](https://docs-vnext.kiflo.com/developers/authentication.md): Generate, use, and revoke Kiflo API Access Tokens to authenticate every REST API request from your app, script, or third-party integration. - [Set Up and Install the Kiflo JS SDK on Your Website](https://docs-vnext.kiflo.com/developers/js-sdk/get-started.md): Install the Kiflo JS snippet on your website to start tracking partner referrals, then verify your setup and enable cross-subdomain cookie tracking. - [JS SDK: Track New Customer Sign-Ups from Referrals](https://docs-vnext.kiflo.com/developers/js-sdk/create-customer.md): Call kiflo('customer', ...) on sign-up to attribute new customers to their referring partner and automatically trigger partner rewards. - [JS SDK: Submit Referred Leads with Partner Attribution](https://docs-vnext.kiflo.com/developers/js-sdk/create-lead.md): Call kiflo('lead', ...) when a prospect submits a form to attribute the lead to their referring partner and trigger partner rewards. - [JS SDK: Register New Partner Applications via Form](https://docs-vnext.kiflo.com/developers/js-sdk/create-partner.md): Call kiflo('partner', ...) on form submission to enroll new partner applicants directly into your Kiflo program from your website. - [JS SDK: Record Sales Transactions and Reward Partners](https://docs-vnext.kiflo.com/developers/js-sdk/create-transaction.md): Call kiflo('transaction', ...) when a sale occurs to record the transaction in Kiflo and automatically trigger the correct partner reward. - [JS SDK: Read the Referral Tracking Code from Cookies](https://docs-vnext.kiflo.com/developers/js-sdk/tracking-code.md): Use kiflo('getTrackingCode') to read the current partner referral code from the browser cookie and pass it to your backend for server-side attribution. - [JS SDK: Subscribe to Referral and Cookie Ready Events](https://docs-vnext.kiflo.com/developers/js-sdk/subscribe-to-events.md): Use the Kiflo JS event system to react in real time when the SDK loads or a referral tracking cookie becomes available on the page. - [Get account information](https://docs-vnext.kiflo.com/api-reference/account/get-account-information.md) - [Upload attachment from file](https://docs-vnext.kiflo.com/api-reference/attachments/upload-attachment-from-file.md): Upload and create one attachment linked to a partner, deal, lead, note, payout, customer, or collaboration. - [Upload attachment from URL](https://docs-vnext.kiflo.com/api-reference/attachments/upload-attachment-from-url.md): Download a file from a given URL and create an attachment linked to a partner, deal, lead, note, payout, customer, or collaboration. - [Get attachments](https://docs-vnext.kiflo.com/api-reference/attachments/get-attachments.md): Get all attachments, filtered by entity. - [Get attachment](https://docs-vnext.kiflo.com/api-reference/attachments/get-attachment.md): Get a single attachment by its ID, including a temporary download URL. - [Get partner certifications](https://docs-vnext.kiflo.com/api-reference/certifications/get-partner-certifications.md): Get all certifications defined in your account - [Create Channel Conflict](https://docs-vnext.kiflo.com/api-reference/channelconflicts/create-channel-conflict.md) - [List contact properties](https://docs-vnext.kiflo.com/api-reference/contactproperties/list-contact-properties.md): List all custom properties defined on contact object. You can customize the contact properties from your [account's settings page](https://app.kiflo.com/account/properties). - [List contacts](https://docs-vnext.kiflo.com/api-reference/contacts/list-contacts.md): List contacts and filter them by any custom properties. To filter contacts on custom property, just add the property with its exact value as a query parameter: `myCustomProp=ThisIsAValue` This will return the contacts where myCustomProp exactly matches the provided value. - [Create contact](https://docs-vnext.kiflo.com/api-reference/contacts/create-contact.md): Create a new contact. Contacts must be associated with deals in order to be visible. - [Get contact](https://docs-vnext.kiflo.com/api-reference/contacts/get-contact.md): Retrieve an existing contact by id. - [Update contact](https://docs-vnext.kiflo.com/api-reference/contacts/update-contact.md): You can only specify properties to update in the `properties` field as this method will PATCH the existing contact. Properties not found in the `properties` field will not be modified. - [List customers](https://docs-vnext.kiflo.com/api-reference/customers/list-customers.md): List customers and filter them by partner or any custom properties. To filter customers on custom property, just add the property with its exact value as a query parameter: `myCustomProp=ThisIsAValue` This will return the customers where myCustomProp exactly matches the provided… - [Create customer](https://docs-vnext.kiflo.com/api-reference/customers/create-customer.md): Create a new customer and optionnaly associate it with an existing partner. **Examples:** To associate the customer with the partner ID 42, set the `partnerId` property to be: `"partnerId": 42` If the customer comes from your website via a referral link shared by a partner a… - [Get customer](https://docs-vnext.kiflo.com/api-reference/customers/get-customer.md): Retrieve an existing customer by id. - [Update customer](https://docs-vnext.kiflo.com/api-reference/customers/update-customer.md): You must specify all properties in the `properties` field as this method will update the whole customer. - [Delete customer](https://docs-vnext.kiflo.com/api-reference/customers/delete-customer.md) - [Patch customer](https://docs-vnext.kiflo.com/api-reference/customers/patch-customer.md) - [List customer properties](https://docs-vnext.kiflo.com/api-reference/customersproperties/list-customer-properties.md): List all custom properties defined on customer object. You can customize the customer properties from your [account's settings page](https://app.kiflo.com/account/properties). - [List deal stages](https://docs-vnext.kiflo.com/api-reference/dealpipelines/list-deal-stages.md): List all available stages on the deal board, as defined on your [account's settings page](https://app.kiflo.com/account/deals). - [List deal properties](https://docs-vnext.kiflo.com/api-reference/dealproperties/list-deal-properties.md): List all custom properties defined on deal object. You can customize the deal properties from your [account's settings page](https://app.kiflo.com/account/properties). - [List deals](https://docs-vnext.kiflo.com/api-reference/deals/list-deals.md): List deals and filter them by custom properties. To filter deals on custom property, just add the property with its exact value as a query parameter: `myCustomProp=ThisIsAValue` This will return the deals where myCustomProp exactly matches the provided value. - [Create deal](https://docs-vnext.kiflo.com/api-reference/deals/create-deal.md): Create a new deal and associate roles on it for existing partners. ## Body parameters | Parameter | Type | Description | |---|---|---| | `contactId` | integer | ID of an existing contact to link to this deal. Mutually exclusive with `contact`. | | `stage` | string |… - [Get deal](https://docs-vnext.kiflo.com/api-reference/deals/get-deal.md): Retrieve an existing deal by id. - [Update deal](https://docs-vnext.kiflo.com/api-reference/deals/update-deal.md): You can only specify properties to update in the `properties` field as this method will PATCH the existing deal. Properties not found in the `properties` field will not be modified. - [Add partner on a deal](https://docs-vnext.kiflo.com/api-reference/deals/add-partner-on-a-deal.md): Adding a partner with a specific role on a deal will make the deal available for the partner on his partner portal. Use the `isSource` property to define whether the partner is also the source of the deal or not. If true, the partner is defined is defined as the source of the deal, no… - [Accept deal](https://docs-vnext.kiflo.com/api-reference/deals/accept-deal.md): Accept a deal and set its status to Accepted - [Refuse deal](https://docs-vnext.kiflo.com/api-reference/deals/refuse-deal.md): Refuse a deal and set its status to Refused - [Associate a customer to a deal. You can either: * associate an existing customer to and existing deal, by `customerId` * create a new customer and associate with an existing deal, using `customer` field Specify either the `customerId` field or the `customer` field. Here is an example when you associate an existing customer by ID: ``` json { "customerId": 42 } ``` Here is an example when you create a new customer. The \`properties\` field contains the list of custom properties defined on **Customers**. ``` json { "customer": { "properties": { "name": "John Doe", "email": "john.doe@customer.com", "...": "..." }, "partnerId": 42, "source": "Deal" } } ```](https://docs-vnext.kiflo.com/api-reference/deals/associate-a-customer-to-a-deal you-can-either: *--associate-an-existing-customer-to-and-existing-deal-by-`customerid` *--create-a-new-customer-and-associate-with-an-existing-deal-using-`customer`-field specify-either-the-`customerid`-field-or-the-`customer`-field--- here-is-an-example-when-you-associate-an-existing-customer-by-id: ```-json --"customerid":-42 ``` here-is-an-example-when-you-create-a-new-customer-the-\`properties\`-field-contains-the-list-of-custom-properties-defined-on-**customers** ```-json --"customer":- ----"properties":- ------"name":-"john-doe" ------"email":-"johndoe@customercom" ------"":-"" ---- ----"partnerid":-42 ----"source":-"deal" -- ```.md): Associate a customer to a deal - [List email templates.](https://docs-vnext.kiflo.com/api-reference/emailtemplates/list-email-templates.md): List email templates. - [List groups](https://docs-vnext.kiflo.com/api-reference/groups/list-groups.md): List groups. - [List lead properties](https://docs-vnext.kiflo.com/api-reference/leadproperties/list-lead-properties.md): List all custom properties defined on lead object. You can customize the lead properties from your [account's settings page](https://app.kiflo.com/account/properties). - [List leads](https://docs-vnext.kiflo.com/api-reference/leads/list-leads.md): List leads and filter them by partner, status or any custom properties. To filter leads on custom property, just add the property with its exact value as a query parameter: `myCustomProp=ThisIsAValue` This will return the leads where myCustomProp exactly matches the provided val… - [Create lead](https://docs-vnext.kiflo.com/api-reference/leads/create-lead.md): Create a new lead. You can assigned the lead with an existing partner using the `partnerId` property. You will be the source of the lead and the partner will have to accept or refuse the lead. You can set the source of the lead using the `sourcePartnerId` property. By doing that, you cre… - [Get lead](https://docs-vnext.kiflo.com/api-reference/leads/get-lead.md): Retrieve an existing lead by id. - [Update lead](https://docs-vnext.kiflo.com/api-reference/leads/update-lead.md): Update an existing lead. You can changed the partner team member assigned on the lead using the `assignedContactEmail` prop.This has to be the email address of an existing team member in the partner's team. - [Accept lead](https://docs-vnext.kiflo.com/api-reference/leads/accept-lead.md): Accept a lead and set its status to Accepted - [Refuse lead](https://docs-vnext.kiflo.com/api-reference/leads/refuse-lead.md): Refuse a lead and set its status to Refused - [Abandon lead](https://docs-vnext.kiflo.com/api-reference/leads/abandon-lead.md): Abandon a lead and set its status to Abandoned - [Convert lead to deal](https://docs-vnext.kiflo.com/api-reference/leads/convert-lead-to-deal.md): Convert a lead to a deal and set its status to Converted - [Convert lead to customer](https://docs-vnext.kiflo.com/api-reference/leads/convert-lead-to-customer.md): Convert a lead to a customer and set its status to Converted. - [List line items on a given deal](https://docs-vnext.kiflo.com/api-reference/lineitems/list-line-items-on-a-given-deal.md): List line items on a given deal. - [Create line item](https://docs-vnext.kiflo.com/api-reference/lineitems/create-line-item.md): Create a new line item on a given deal. - [Delete line item](https://docs-vnext.kiflo.com/api-reference/lineitems/delete-line-item.md) - [Patch line item](https://docs-vnext.kiflo.com/api-reference/lineitems/patch-line-item.md): This method patches an existing line item. You can leave some properties empty in the request body, they won't be modified. - [Get notes](https://docs-vnext.kiflo.com/api-reference/notes/get-notes.md): Get all notes defined in your account - [Create note](https://docs-vnext.kiflo.com/api-reference/notes/create-note.md): Create a new note and assign it with an existing partner, leads, deal, customer or payout. The `content` prop can be formatted using simple HTML formatting. - [Get partner onboarding stages](https://docs-vnext.kiflo.com/api-reference/onboarding/get-partner-onboarding-stages.md): Get all partner onboarding stages. - [List onboarding stages for a given onboarding pipeline](https://docs-vnext.kiflo.com/api-reference/onboarding/list-onboarding-stages-for-a-given-onboarding-pipeline.md) - [List onboarding pipelines](https://docs-vnext.kiflo.com/api-reference/onboarding/list-onboarding-pipelines.md) - [List partner applications](https://docs-vnext.kiflo.com/api-reference/partnerapplications/list-partner-applications.md): List partner applications and filter them. - [Get partner application](https://docs-vnext.kiflo.com/api-reference/partnerapplications/get-partner-application.md) - [Accept a pending Partner Application](https://docs-vnext.kiflo.com/api-reference/partnerapplications/accept-a-pending-partner-application.md) - [Reject a pending Partner Application](https://docs-vnext.kiflo.com/api-reference/partnerapplications/reject-a-pending-partner-application.md) - [List certifications given to partner contacts.](https://docs-vnext.kiflo.com/api-reference/partnercontactcertifications/list-certifications-given-to-partner-contacts.md): List the certifications for all partners, all partner contacts of one given partner of just one partner contact only. - [Give a certification to a partner team member](https://docs-vnext.kiflo.com/api-reference/partnercontactcertifications/give-a-certification-to-a-partner-team-member.md): Associate a certification to a partner team member - [List partner contacts](https://docs-vnext.kiflo.com/api-reference/partnercontacts/list-partner-contacts.md): List the contacts for all partners and filter them by partner or email. - [List partner contacts](https://docs-vnext.kiflo.com/api-reference/partnercontacts/list-partner-contacts-1.md): List the contacts for all partners and filter them by partner or email. - [Send invitation email to join the partner portal.](https://docs-vnext.kiflo.com/api-reference/partnercontacts/send-invitation-email-to-join-the-partner-portal.md): It only sends the email if the team member was not already invited to the partner portal. - [Send invitation email to join the partner portal.](https://docs-vnext.kiflo.com/api-reference/partnercontacts/send-invitation-email-to-join-the-partner-portal-1.md): It only sends the email if the team member was not already invited to the partner portal. - [List partner properties](https://docs-vnext.kiflo.com/api-reference/partnerproperties/list-partner-properties.md): List all custom properties defined on partner object. You can customize the partner properties from your [account's settings page](https://app.kiflo.com/account/properties). - [List partners](https://docs-vnext.kiflo.com/api-reference/partners/list-partners.md): List partners and filter them by name, email or any custom properties. To filter partners on custom property, just add the property with its exact value as a query parameter: `myCustomProp=ThisIsAValue` This will return the partners where myCustomProp exactly matches the provided v… - [Create partner](https://docs-vnext.kiflo.com/api-reference/partners/create-partner.md): Create a new partner. - [Get partner](https://docs-vnext.kiflo.com/api-reference/partners/get-partner.md): Retrieve an existing partner by id. - [Update partner](https://docs-vnext.kiflo.com/api-reference/partners/update-partner.md): You can only specify properties to update in the `properties` field as this method will PATCH the existing partner. Properties not found in the `properties` field will not be modified. - [Get partner types](https://docs-vnext.kiflo.com/api-reference/partners/get-partner-types.md): Get all partner types. - [Get partner prospection stages](https://docs-vnext.kiflo.com/api-reference/partners/get-partner-prospection-stages.md): Get all partner prospection stages. - [Get partner links](https://docs-vnext.kiflo.com/api-reference/partners/get-partner-links.md): Get all partner links. - [Get partner link statistics](https://docs-vnext.kiflo.com/api-reference/partners/get-partner-link-statistics.md): Get all statistics relative to links for a partner. - [Start an onboarding for a partner.](https://docs-vnext.kiflo.com/api-reference/partners/start-an-onboarding-for-a-partner.md): Move the given partner in the specified onboarding pipeline and optionally start at a given stage. - [List payout properties](https://docs-vnext.kiflo.com/api-reference/payoutproperties/list-payout-properties.md): List all custom properties defined on payout object. You can customize the payout properties from your [account's settings page](https://app.kiflo.com/account/properties). - [List payouts](https://docs-vnext.kiflo.com/api-reference/payouts/list-payouts.md): List payouts and filter them by partner or any custom properties. To filter payouts on custom property, just add the property with its exact value as a query parameter: `myCustomProp=ThisIsAValue` This will return the payout where myCustomProp exactly matches the provided value. - [Create payouts](https://docs-vnext.kiflo.com/api-reference/payouts/create-payouts.md): It creates payouts from rewards matching the specified criteria. If no rewards match the given criteria no payout is created. **Examples:** To create payouts for all partners from all pending rewards within a specific date range: `{ "fromDate": "2022-01-01T00:00:00Z", "to… - [Get payout](https://docs-vnext.kiflo.com/api-reference/payouts/get-payout.md): Retrieve an existing payout by id. - [Update Payout](https://docs-vnext.kiflo.com/api-reference/payouts/update-payout.md): You can only specify properties to update in the `properties` field as this method will PATCH the existing payout. Properties not found in the `properties` field will not be modified. - [Validate a payout](https://docs-vnext.kiflo.com/api-reference/payouts/validate-a-payout.md): When validating a payout you can ask your partner to: - Validate all rewards - Attach an invoice You can ask your partner to do both actions or none of them. **Examples:** To validate a payout and ask your partner to attach an invoice: `{ "shouldAttachInvoice": true, }`… - [Invalidate a payout](https://docs-vnext.kiflo.com/api-reference/payouts/invalidate-a-payout.md): Moves a Ready or Pending payout back to Draft status, clearing its validation state. Only payouts in the Ready or Pending status can be invalidated. - [Accept a payout](https://docs-vnext.kiflo.com/api-reference/payouts/accept-a-payout.md) - [Pay a payout](https://docs-vnext.kiflo.com/api-reference/payouts/pay-a-payout.md) - [List product prices](https://docs-vnext.kiflo.com/api-reference/productprices/list-product-prices.md): List all prices associated with a given product. - [Create product price](https://docs-vnext.kiflo.com/api-reference/productprices/create-product-price.md): Create a new price for a given product. - [Update product price](https://docs-vnext.kiflo.com/api-reference/productprices/update-product-price.md): Update an existing price for a given product. - [Delete product price](https://docs-vnext.kiflo.com/api-reference/productprices/delete-product-price.md): Delete a price for a given product. - [List products](https://docs-vnext.kiflo.com/api-reference/products/list-products.md): List products and filter them by any custom properties. To filter products on custom property, just add the property with its exact value as a query parameter: `myCustomProp=ThisIsAValue` This will return the products where myCustomProp exactly matches the provided value. - [Create product](https://docs-vnext.kiflo.com/api-reference/products/create-product.md): Create a new product. - [Delete product](https://docs-vnext.kiflo.com/api-reference/products/delete-product.md): Delete an existing product. - [Patch product](https://docs-vnext.kiflo.com/api-reference/products/patch-product.md) - [List partner programs](https://docs-vnext.kiflo.com/api-reference/programs/list-partner-programs.md): List partner programs. Warning: the BadgeUrl is a temporary link that works only for 72 hours for each request. - [List partner properties](https://docs-vnext.kiflo.com/api-reference/rewardproperties/list-partner-properties.md): List all custom properties defined on partner object. You can customize the partner properties from your [account's settings page](https://app.kiflo.com/account/properties). - [List rewards](https://docs-vnext.kiflo.com/api-reference/rewards/list-rewards.md): List rewards and filter them by partner and/or date range. - [Create reward](https://docs-vnext.kiflo.com/api-reference/rewards/create-reward.md): Create a new reward. - [List subscriptions](https://docs-vnext.kiflo.com/api-reference/subscriptions/list-subscriptions.md) - [Subscribe](https://docs-vnext.kiflo.com/api-reference/subscriptions/subscribe.md): Create a new subscription on a webhook. The payload contains the following fields: - `eventSource`: the name of the webhook to subscribe for. Refer to the Events section to find the list of all available webhooks. - `targetUrl`: the HTTP callback that will receive the webhook payloa… - [Unsubscribe](https://docs-vnext.kiflo.com/api-reference/subscriptions/unsubscribe.md): Delete an existing webhook subscription. - [List transaction properties](https://docs-vnext.kiflo.com/api-reference/transactionproperties/list-transaction-properties.md): List all custom properties defined on transaction object. You can customize the transaction properties from your [account's settings page](https://app.kiflo.com/account/properties). - [List transactions](https://docs-vnext.kiflo.com/api-reference/transactions/list-transactions.md): List transactions and filter them by partner, customer or any custom properties. To filter transactions on custom property, just add the property with its exact value as a query parameter: `myCustomProp=ThisIsAValue` This will return the transactions where myCustomProp exactly m… - [Create transaction](https://docs-vnext.kiflo.com/api-reference/transactions/create-transaction.md): Create a new transaction and associate it with an existing customer. **Example 1:** To associate the transaction with the customer ID 42, set the `customer` property to be: `"customer": { "id": 42 }` **Example 2:** To associate the transaction with the customer email "… - [Get transaction](https://docs-vnext.kiflo.com/api-reference/transactions/get-transaction.md): Retrieve an existing transaction by id. - [Update transaction](https://docs-vnext.kiflo.com/api-reference/transactions/update-transaction.md): You must specify all properties in the `properties` field as this method will update the whole transaction. - [Delete transaction](https://docs-vnext.kiflo.com/api-reference/transactions/delete-transaction.md) ## OpenAPI Specs - [openapi](https://docs-vnext.kiflo.com/openapi.json)