Partners

Partners are users that have access to Kiflo and promote your company.

post
Create Partner

https://api.kiflo.com/v2/partners
Create a new partner.
Request
Response
Request
Headers
Authorization
required
string
API Access Token or App ID using Bearer scheme
Body Parameters
source
optional
string
The source name where the partner came from. Used for reporting purpose on the UI. Possible values: ManuallyAdded or SignupForm.
email
required
string
The partner email.
companyName
optional
string
The partner company name.
groupId
required
integer
The technical Kiflo identifier of the group in which the partner must be added.
firstName
required
string
The partner firstname.
lastName
required
string
The partner lastname.
Response
200: OK
Returns the created partner.
{
id: 42,
name: "Amazon",
groupId: 2,
status: "Active",
source: "SignupForm",
company: {
id: 10,
name: "Amazon"
},
mainContact: {
id: 20,
email: "jeff.bezos@amazon.com",
firstname: "Jeff",
lastname: "Bezos",
creationDate: "2019-01-31T14:30:10.010Z"
}
}

get
Get Partner

https://api.kiflo.com/v2/partners/:id
Request
Response
Request
Path Parameters
id
required
integer
The partner ID.
Headers
Authorization
required
string
The API Access Token using Bearer scheme.
Response
200: OK
{
id: 42,
name: "Amazon",
groupId: 2,
status: "Active",
source: "SignupForm",
company: {
id: 10,
name: "Amazon"
},
mainContact: {
id: 20,
email: "jeff.bezos@amazon.com",
firstname: "Jeff",
lastname: "Bezos",
creationDate: "2019-01-31T14:30:10.010Z"
}
}

get
List Partners

https://api.kiflo.com/v2/partners
List partners with pagination.
Request
Response
Request
Headers
Authorization
required
string
The API Acess Token using Bearer scheme.
Query Parameters
name
optional
string
The name of the partners to return.
offset
optional
integer
The offset from which results must be returned. Default is 0.
limit
optional
integer
The maximum number of results to return. Default is 20.
sort_by
optional
string
The name of the property used to sort the resutls. Default is Name.
order_by
optional
string
The sorting direction, can be Asc or Desc. Default is Asc.
Response
200: OK
{
items: [{
id: 42,
name: "Amazon",
groupId: 2,
status: "Active",
source: "SignupForm",
company: {
id: 10,
name: "Amazon"
},
mainContact: {
id: 20,
email: "jeff.bezos@amazon.com",
firstname: "Jeff",
lastname: "Bezos",
creationDate: "2019-01-31T14:30:10.010Z"
}
}]
}