Malinks

/api/v1/exports/

GET OPTIONS

List Exports

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
name	Name
custom_report_name	Custom Report Name
title	Title
description	Description
status	Status
rows_count	Rows Count
exported_rows_count	Exported Rows Count
args	Args
type	Type
start_time	Start Time
end_time	End Time
user	User
errors	Errors
is_custom	Is Custom
start_date	Start Date
end_date	End Date
list_size	List Size

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
status_display: CharField,
completed_percentage: ReadOnlyField,
rows_count: MyCustomSerializerField,
exported_rows_count: MyCustomSerializerField,
duration: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
custom_report_name: CharField,
title: CharField,
description: CharField,

status: ChoiceField,

Choices

Value	Meaning
Q	Queued
E	Exporting...
P	Preparing Download...
F	Failed
D	Click To Download

args: CharField,

type: ChoiceField,

Choices

Value	Meaning
C	CSV
P	PDF

file: FileField,
start_time: DateTimeField,
end_time: DateTimeField,
errors: CharField,
is_custom: BooleanField,
start_date: DateField,
end_date: DateField,

list_size: ChoiceField,

Choices

Value	Meaning
20	20
50	50
100	100
300	300
500	500
800	800
1000	1000
10000	10000

user: PrimaryKeyRelatedField Help Text

}

users

/api/v1/users/

GET POST OPTIONS

List Create Clients

Open Link

Description
Authentication
Permissions
Filters

{ "profile":{response fields below}, "token":{..} }

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsSuperAdminOrPOSTOnly	The request is authenticated as a user, or is a read-only request.

Param name	Description
password	Password
last_login	Last Login
is_superuser	Is Superuser
groups	Groups
user_permissions	User Permissions
username	Username
first_name	First Name
last_name	Last Name
is_staff	Is Staff
is_active	Is Active
date_joined	Date Joined
last_activity	Last Activity
role	Role
phone	Phone
google_profile_image	Google Profile Image
confirm_code	Confirm Code
reset_code	Reset Code
old_password	Old Password
changed_password	Changed Password
verified	Verified
dummy	Dummy
available	Available
email	Email
dob	Dob
gender	Gender
allow_messages_import	Allow Messages Import
is_creator	Is Creator

Request Fields:

{

image: Base64ImageField,
password: CharField, Required
last_login: DateTimeField,
username: CharField, Help Text
first_name: CharField,
last_name: CharField,
date_joined: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
N	Normal
A	Admin
C	Customer Care
T	Technician

phone: CharField,
google_profile_image: URLField,
verified: BooleanField,
dummy: BooleanField,
email: EmailField, Required
dob: DateField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
RNS	Rather Not Say

allow_messages_import: BooleanField,
is_creator: BooleanField

}

Response Fields:

{

id: IntegerField,
image: Base64ImageField,
profile_image: SerializerMethodField,
full_name: CharField,
last_login: DateTimeField,
username: CharField, Help Text
first_name: CharField,
last_name: CharField,
date_joined: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
N	Normal
A	Admin
C	Customer Care
T	Technician

phone: CharField,
google_profile_image: URLField,
verified: BooleanField,
dummy: BooleanField,
available: BooleanField,
email: EmailField,
dob: DateField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
RNS	Rather Not Say

allow_messages_import: BooleanField,
is_creator: BooleanField

}

/api/v1/users/me/

GET PUT PATCH OPTIONS

Retrieve Update Client

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

image: Base64ImageField,
password: CharField, Required
last_login: DateTimeField,
username: CharField, Help Text
first_name: CharField,
last_name: CharField,
date_joined: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
N	Normal
A	Admin
C	Customer Care
T	Technician

phone: CharField,
google_profile_image: URLField,
verified: BooleanField,
dummy: BooleanField,
email: EmailField, Required
dob: DateField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
RNS	Rather Not Say

allow_messages_import: BooleanField,
is_creator: BooleanField

}

Response Fields:

{

id: IntegerField,
image: Base64ImageField,
profile_image: SerializerMethodField,
full_name: CharField,
last_login: DateTimeField,
username: CharField, Help Text
first_name: CharField,
last_name: CharField,
date_joined: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
N	Normal
A	Admin
C	Customer Care
T	Technician

phone: CharField,
google_profile_image: URLField,
verified: BooleanField,
dummy: BooleanField,
available: BooleanField,
email: EmailField,
dob: DateField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
RNS	Rather Not Say

allow_messages_import: BooleanField,
is_creator: BooleanField

}

/api/v1/users/technicians/

GET OPTIONS

List Technicians

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.
IsSafariNjemaCustomerCareOrAdmin	A base class from which all permission classes should inherit.

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
image: Base64ImageField,
profile_image: SerializerMethodField,
full_name: CharField,
last_login: DateTimeField,
username: CharField, Help Text
first_name: CharField,
last_name: CharField,
date_joined: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
N	Normal
A	Admin
C	Customer Care
T	Technician

phone: CharField,
google_profile_image: URLField,
verified: BooleanField,
dummy: BooleanField,
available: BooleanField,
email: EmailField,
dob: DateField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
RNS	Rather Not Say

allow_messages_import: BooleanField,
is_creator: BooleanField

}

/api/v1/users/me/profile/

GET PUT PATCH OPTIONS

Retrieve Client

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

image: Base64ImageField,
password: CharField, Required
last_login: DateTimeField,
username: CharField, Help Text
first_name: CharField,
last_name: CharField,
date_joined: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
N	Normal
A	Admin
C	Customer Care
T	Technician

phone: CharField,
google_profile_image: URLField,
verified: BooleanField,
dummy: BooleanField,
email: EmailField, Required
dob: DateField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
RNS	Rather Not Say

allow_messages_import: BooleanField,
is_creator: BooleanField

}

Response Fields:

{

id: IntegerField,
image: Base64ImageField,
profile_image: SerializerMethodField,
full_name: CharField,
last_login: DateTimeField,
username: CharField, Help Text
first_name: CharField,
last_name: CharField,
date_joined: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
N	Normal
A	Admin
C	Customer Care
T	Technician

phone: CharField,
google_profile_image: URLField,
verified: BooleanField,
dummy: BooleanField,
available: BooleanField,
email: EmailField,
dob: DateField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
RNS	Rather Not Say

allow_messages_import: BooleanField,
is_creator: BooleanField

}

/api/v1/users/forgot-password

POST OPTIONS

Clients Forgot Password

Open Link

Description
Authentication

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/users/reset-password

POST PUT PATCH OPTIONS

Clients Reset Password

Open Link

Description
Authentication

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Request Fields:

{

reset_code: IntegerField, Required
new_password: CharField Required

}

Response Fields:

{

reset_code: IntegerField,
new_password: CharField

}

brands

/api/v1/brands/<int:pk>/feed-posts/

GET POST OPTIONS

List Create Brand Feed Posts

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
title	Title
description	Description
start_date	Start Date
color	Color
should_update_color	Should Update Color
brand	Brand
is_published	Is Published
tags	Tags
plan	Plan

Request Fields:

{

title: CharField, Required
description: CharField, Required
start_date: DateField,
image: ImageField,
color: CharField,
is_published: BooleanField,
tags: CharField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

brand: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,

brand_details: BrandSerializer,

Item structure

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
subscription_fee_currency_display: ReadOnlyField,
business_type_display: ReadOnlyField,
subscription_fee_duration_display: ReadOnlyField,

users_details: ListSerializer,

Item structure

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- brand: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
title: CharField,
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

created: DateTimeField,
modified: DateTimeField,
title: CharField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
is_published: BooleanField,
tags: CharField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

brand: PrimaryKeyRelatedField Help Text

}

/api/v1/brands/<int:pk>/link-items/

GET POST OPTIONS

List Create Brand Brand Link Items

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
start_date	Start Date
color	Color
should_update_color	Should Update Color
value	Value
title	Title
description	Description
link_item	Link Item
brand	Brand

Request Fields:

{

start_date: DateField,
image: ImageField,
color: CharField,
value: CharField, Required
file: FileField,
title: CharField,
description: CharField,
link_item: PrimaryKeyRelatedField, Required Help Text
brand: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
link_item_name: ReadOnlyField,
link_item_icon: ReadOnlyField,
link_item_url_prefix: ReadOnlyField,
link_item_url_allow_multiple: ReadOnlyField,
link_item_media_type: ReadOnlyField,
link_item_media_type_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
value: CharField,
file: FileField,
title: CharField,
description: CharField,
link_item: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

/api/v1/brands/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Brand

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

description: CharField, Required
start_date: DateField,
image: ImageField,
color: CharField,
title: CharField, Required
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
subscription_fee_currency_display: ReadOnlyField,
business_type_display: ReadOnlyField,
subscription_fee_duration_display: ReadOnlyField,

users_details: ListSerializer,

Item structure

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- brand: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
title: CharField,
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

/api/v1/brands/me/

GET POST OPTIONS

List Create My Brands

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
description	Description
start_date	Start Date
color	Color
should_update_color	Should Update Color
title	Title
created_by	Created By
verified	Verified
active	Active
business_type	Business Type
subscription_fee_currency	Subscription Fee Currency
subscription_fee_amount	Subscription Fee Amount
subscription_fee_duration	Subscription Fee Duration
redirect_url	Redirect Url

Request Fields:

{

description: CharField, Required
start_date: DateField,
image: ImageField,
color: CharField,
title: CharField, Required
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
subscription_fee_currency_display: ReadOnlyField,
business_type_display: ReadOnlyField,
subscription_fee_duration_display: ReadOnlyField,

users_details: ListSerializer,

Item structure

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- brand: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
title: CharField,
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

/api/v1/brands/unfollowing/

GET OPTIONS

List Unfolled Brands

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
description	Description
start_date	Start Date
color	Color
should_update_color	Should Update Color
title	Title
created_by	Created By
verified	Verified
active	Active
business_type	Business Type
subscription_fee_currency	Subscription Fee Currency
subscription_fee_amount	Subscription Fee Amount
subscription_fee_duration	Subscription Fee Duration
redirect_url	Redirect Url

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
subscription_fee_currency_display: ReadOnlyField,
business_type_display: ReadOnlyField,
subscription_fee_duration_display: ReadOnlyField,

users_details: ListSerializer,

Item structure

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- brand: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
title: CharField,
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

/api/v1/brands/inactive/

GET OPTIONS

List Inactive Brands

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
description	Description
start_date	Start Date
color	Color
should_update_color	Should Update Color
title	Title
created_by	Created By
verified	Verified
active	Active
business_type	Business Type
subscription_fee_currency	Subscription Fee Currency
subscription_fee_amount	Subscription Fee Amount
subscription_fee_duration	Subscription Fee Duration
redirect_url	Redirect Url

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
subscription_fee_currency_display: ReadOnlyField,
business_type_display: ReadOnlyField,
subscription_fee_duration_display: ReadOnlyField,

users_details: ListSerializer,

Item structure

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- brand: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
title: CharField,
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

/api/v1/brands/

GET POST OPTIONS

List Create All Brands

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
description	Description
start_date	Start Date
color	Color
should_update_color	Should Update Color
title	Title
created_by	Created By
verified	Verified
active	Active
business_type	Business Type
subscription_fee_currency	Subscription Fee Currency
subscription_fee_amount	Subscription Fee Amount
subscription_fee_duration	Subscription Fee Duration
redirect_url	Redirect Url

Request Fields:

{

description: CharField, Required
start_date: DateField,
image: ImageField,
color: CharField,
title: CharField, Required
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
subscription_fee_currency_display: ReadOnlyField,
business_type_display: ReadOnlyField,
subscription_fee_duration_display: ReadOnlyField,

users_details: ListSerializer,

Item structure

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- brand: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
title: CharField,
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

brand-users

/api/v1/brand-users/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Brand User

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Required Help Text
user: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
user_name: ReadOnlyField,
role_display: ReadOnlyField,
status_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/brand-users/

GET POST OPTIONS

List Create Brand Users

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
brand	Brand
role	Role
user	User
percentage	Percentage
status	Status
active	Active

Request Fields:

{

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Required Help Text
user: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
user_name: ReadOnlyField,
role_display: ReadOnlyField,
status_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

brand-link-items

/api/v1/brand-link-items/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Brand Link Item

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

start_date: DateField,
image: ImageField,
color: CharField,
value: CharField, Required
file: FileField,
title: CharField,
description: CharField,
link_item: PrimaryKeyRelatedField, Required Help Text
brand: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
link_item_name: ReadOnlyField,
link_item_icon: ReadOnlyField,
link_item_url_prefix: ReadOnlyField,
link_item_url_allow_multiple: ReadOnlyField,
link_item_media_type: ReadOnlyField,
link_item_media_type_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
value: CharField,
file: FileField,
title: CharField,
description: CharField,
link_item: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

brand-followings

/api/v1/brand-followings/<int:pk>/

GET DELETE OPTIONS

Retrieve Update Destroy Brand Following

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

user: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
created: DateTimeField,
modified: DateTimeField,
join_date: DateField,
active: BooleanField,
user: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

/api/v1/brand-followings/

GET POST OPTIONS

List Create Brand Followings

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
user	User
brand	Brand
join_date	Join Date
active	Active

Request Fields:

{

user: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
created: DateTimeField,
modified: DateTimeField,
join_date: DateField,
active: BooleanField,
user: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

brand-memberships

/api/v1/brand-memberships/<int:pk>/

GET PUT PATCH OPTIONS

Retrieve Update Destroy Brand Membership

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

user: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
status_display: ReadOnlyField,
is_active: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
join_date: DateField,
active: BooleanField,
active_end_date: DateField,
complete: BooleanField,
status: CharField,
user: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

/api/v1/brand-memberships/<int:pk>/activate/

PUT PATCH OPTIONS

Retrieve Update Activate Brand Membership

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

serial_number: CharField, Required

}

Response Fields:

{

serial_number: CharField,
detail: ReadOnlyField

}

/api/v1/brand-memberships/

GET POST OPTIONS

List Create Brand Memberships

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
user	User
brand	Brand
join_date	Join Date
active	Active
active_end_date	Active End Date
complete	Complete
status	Status

Request Fields:

{

user: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
status_display: ReadOnlyField,
is_active: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
join_date: DateField,
active: BooleanField,
active_end_date: DateField,
complete: BooleanField,
status: CharField,
user: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

projects

/api/v1/projects/<int:pk>/link-items/

GET POST OPTIONS

List Create Project Project Link Items

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
start_date	Start Date
color	Color
should_update_color	Should Update Color
value	Value
title	Title
description	Description
link_item	Link Item
project	Project

Request Fields:

{

start_date: DateField,
image: ImageField,
color: CharField,
value: CharField, Required
file: FileField,
title: CharField,
description: CharField,
link_item: PrimaryKeyRelatedField, Required Help Text
project: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
link_item_name: ReadOnlyField,
link_item_icon: ReadOnlyField,
link_item_url_prefix: ReadOnlyField,
link_item_url_allow_multiple: ReadOnlyField,
link_item_media_type: ReadOnlyField,
link_item_media_type_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
value: CharField,
file: FileField,
title: CharField,
description: CharField,
link_item: PrimaryKeyRelatedField, Help Text
project: PrimaryKeyRelatedField Help Text

}

/api/v1/projects/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Project

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

title: CharField, Required
description: CharField, Required
start_date: DateField,
image: ImageField,
color: CharField,
active: BooleanField,
redirect_url: URLField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

created_by: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
plan_display: ReadOnlyField,
link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- project: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
title: CharField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
active: BooleanField,
redirect_url: URLField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

created_by: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

/api/v1/projects/me/

GET POST OPTIONS

List Create My Projects

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
title	Title
description	Description
start_date	Start Date
color	Color
should_update_color	Should Update Color
created_by	Created By
active	Active
brand	Brand
redirect_url	Redirect Url
plan	Plan

Request Fields:

{

title: CharField, Required
description: CharField, Required
start_date: DateField,
image: ImageField,
color: CharField,
active: BooleanField,
redirect_url: URLField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

created_by: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
plan_display: ReadOnlyField,
link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- project: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
title: CharField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
active: BooleanField,
redirect_url: URLField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

created_by: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

/api/v1/projects/followed/

GET OPTIONS

List Followed Projects

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
title	Title
description	Description
start_date	Start Date
color	Color
should_update_color	Should Update Color
created_by	Created By
active	Active
brand	Brand
redirect_url	Redirect Url
plan	Plan

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
plan_display: ReadOnlyField,
link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- project: PrimaryKeyRelatedField Help Text
}
is_unlocked: SerializerMethodField,
created: DateTimeField,
modified: DateTimeField,
title: CharField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
active: BooleanField,
redirect_url: URLField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

created_by: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

/api/v1/projects/

GET POST OPTIONS

List Create All Projects

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
title	Title
description	Description
start_date	Start Date
color	Color
should_update_color	Should Update Color
created_by	Created By
active	Active
brand	Brand
redirect_url	Redirect Url
plan	Plan

Request Fields:

{

title: CharField, Required
description: CharField, Required
start_date: DateField,
image: ImageField,
color: CharField,
active: BooleanField,
redirect_url: URLField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

created_by: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
plan_display: ReadOnlyField,
link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- project: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
title: CharField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
active: BooleanField,
redirect_url: URLField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

created_by: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField Help Text

}

project-link-items

/api/v1/project-link-items/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Project Link Item

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

start_date: DateField,
image: ImageField,
color: CharField,
value: CharField, Required
file: FileField,
title: CharField,
description: CharField,
link_item: PrimaryKeyRelatedField, Required Help Text
project: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
link_item_name: ReadOnlyField,
link_item_icon: ReadOnlyField,
link_item_url_prefix: ReadOnlyField,
link_item_url_allow_multiple: ReadOnlyField,
link_item_media_type: ReadOnlyField,
link_item_media_type_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
value: CharField,
file: FileField,
title: CharField,
description: CharField,
link_item: PrimaryKeyRelatedField, Help Text
project: PrimaryKeyRelatedField Help Text

}

nfc-tag-models

/api/v1/nfc-tag-models/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Nfc Tag Model

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

image: ImageField,
color: CharField,
name: CharField, Required
tag_color: CharField,

tag_shape: ChoiceField,

Choices

Value	Meaning
s	Square
c	Circle

manufacturer: CharField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
name: CharField,
tag_color: CharField,

tag_shape: ChoiceField,

Choices

Value	Meaning
s	Square
c	Circle

manufacturer: CharField

}

/api/v1/nfc-tag-models/

GET POST OPTIONS

List Create Nfc Tag Models

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
color	Color
should_update_color	Should Update Color
name	Name
tag_color	Tag Color
tag_shape	Tag Shape
manufacturer	Manufacturer

Request Fields:

{

image: ImageField,
color: CharField,
name: CharField, Required
tag_color: CharField,

tag_shape: ChoiceField,

Choices

Value	Meaning
s	Square
c	Circle

manufacturer: CharField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
name: CharField,
tag_color: CharField,

tag_shape: ChoiceField,

Choices

Value	Meaning
s	Square
c	Circle

manufacturer: CharField

}

nfc-tags

/api/v1/nfc-tags/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Nfc Tag

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

image: ImageField,
color: CharField,
manufacturer_serial: CharField, Required
branded_date: DateField,

type: ChoiceField,

Choices

Value	Meaning
m	Membership
p	Project

is_locked: BooleanField,
order: PrimaryKeyRelatedField, Help Text
model: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
created: DateTimeField,
modified: DateTimeField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
manufacturer_serial: CharField,
branded_date: DateField,

type: ChoiceField,

Choices

Value	Meaning
m	Membership
p	Project

hash: CharField,
is_locked: BooleanField,
order: PrimaryKeyRelatedField, Help Text
model: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/nfc-tags/<str:manufacturer_serial>/

GET PUT PATCH OPTIONS

Retrieve Nfc Tag By Manufacturer Serial

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

image: ImageField,
color: CharField,
manufacturer_serial: CharField, Required
branded_date: DateField,

type: ChoiceField,

Choices

Value	Meaning
m	Membership
p	Project

is_locked: BooleanField,
order: PrimaryKeyRelatedField, Help Text
model: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
created: DateTimeField,
modified: DateTimeField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
manufacturer_serial: CharField,
branded_date: DateField,

type: ChoiceField,

Choices

Value	Meaning
m	Membership
p	Project

hash: CharField,
is_locked: BooleanField,
order: PrimaryKeyRelatedField, Help Text
model: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/nfc-tags/<str:manufacturer_serial>/link/

PUT PATCH OPTIONS

Retrieve Link Nfc Tag By Manufacturer Serial

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

serial_number: CharField, Required

}

Response Fields:

{

serial_number: CharField,
detail: ReadOnlyField

}

/api/v1/nfc-tags/<str:manufacturer_serial>/unlink/

PUT PATCH OPTIONS

Retrieve Unlink Nfc Tag By Manufacturer Serial

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

serial_number: CharField, Required

}

Response Fields:

{

serial_number: CharField,
detail: ReadOnlyField

}

nfc-tag-orders

/api/v1/nfc-tag-orders/<int:pk>/tags/

GET POST OPTIONS

List Create Nfc Order Nfc Tags

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
color	Color
should_update_color	Should Update Color
order	Order
model	Model
manufacturer_serial	Manufacturer Serial
branded_date	Branded Date
brand	Brand
type	Type
hash	Hash
is_locked	Is Locked
user	User

Request Fields:

{

image: ImageField,
color: CharField,
manufacturer_serial: CharField, Required
branded_date: DateField,

type: ChoiceField,

Choices

Value	Meaning
m	Membership
p	Project

is_locked: BooleanField,
order: PrimaryKeyRelatedField, Help Text
model: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
brand_title: ReadOnlyField,
brand_description: ReadOnlyField,
brand_image: ImageField,
brand_business_type_display: ReadOnlyField,
brand_business_type: ReadOnlyField,
brand_cache_image: SerializerMethodField,
brand_avatar_image: SerializerMethodField,
created: DateTimeField,
modified: DateTimeField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
manufacturer_serial: CharField,
branded_date: DateField,

type: ChoiceField,

Choices

Value	Meaning
m	Membership
p	Project

hash: CharField,
is_locked: BooleanField,
order: PrimaryKeyRelatedField, Help Text
model: PrimaryKeyRelatedField, Help Text
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/nfc-tag-orders/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Nfc Tag Order

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

image: ImageField,
color: CharField,
source: CharField, Required
receipt: FileField,
quantity: IntegerField, Required
order_date: DateField,
receive_date: DateField,
amount: FloatField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
source: CharField,
receipt: FileField,
quantity: IntegerField,
order_date: DateField,
receive_date: DateField,
amount: FloatField

}

/api/v1/nfc-tag-orders/

GET POST OPTIONS

List Create Nfc Tag Orders

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
color	Color
should_update_color	Should Update Color
source	Source
quantity	Quantity
order_date	Order Date
receive_date	Receive Date
amount	Amount

Request Fields:

{

image: ImageField,
color: CharField,
source: CharField, Required
receipt: FileField,
quantity: IntegerField, Required
order_date: DateField,
receive_date: DateField,
amount: FloatField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
source: CharField,
receipt: FileField,
quantity: IntegerField,
order_date: DateField,
receive_date: DateField,
amount: FloatField

}

feed-posts

/api/v1/feed-posts/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Feed Post

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

title: CharField, Required
description: CharField, Required
start_date: DateField,
image: ImageField,
color: CharField,
is_published: BooleanField,
tags: CharField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

brand: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,

brand_details: BrandSerializer,

Item structure

{

id: IntegerField,
cache_image: SerializerMethodField,
avatar_image: SerializerMethodField,
subscription_fee_currency_display: ReadOnlyField,
business_type_display: ReadOnlyField,
subscription_fee_duration_display: ReadOnlyField,

users_details: ListSerializer,

Item structure

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,

role: ChoiceField,

Choices

Value	Meaning
OW	Owner
MG	Manager
RO	Read Only
WO	Write Only

percentage: IntegerField,

status: ChoiceField,

Choices

Value	Meaning
R	Requested
A	Accepted
D	Declined

active: BooleanField,
brand: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

link_items_details: ListSerializer,
Item structure
{
- id: IntegerField,
- cache_image: SerializerMethodField,
- avatar_image: SerializerMethodField,
- link_item_name: ReadOnlyField,
- link_item_icon: ReadOnlyField,
- link_item_url_prefix: ReadOnlyField,
- link_item_url_allow_multiple: ReadOnlyField,
- link_item_media_type: ReadOnlyField,
- link_item_media_type_display: ReadOnlyField,
- created: DateTimeField,
- modified: DateTimeField,
- start_date: DateField,
- image: ImageField,
- color: CharField,
- should_update_color: BooleanField,
- value: CharField,
- file: FileField,
- title: CharField,
- description: CharField,
- link_item: PrimaryKeyRelatedField, Help Text
- brand: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
title: CharField,
verified: BooleanField,
active: BooleanField,

business_type: ChoiceField,

Choices

Value	Meaning
hospitality	Hospitality
music	Music
podcast	Podcast
film	Film
photography	Photography
dance	Dance
tech	Technology
comedy	Comedy
farming	Farming
arts	Arts

subscription_fee_currency: ChoiceField,

Choices

Value	Meaning
KES	Kenyan Shilling
USD	US Dollars
EURO	Euros

subscription_fee_amount: IntegerField,

subscription_fee_duration: ChoiceField,

Choices

Value	Meaning
hourly	Hourly
daily	Daily
weekly	Weekly
monthly	Monthly
yearly	Yearly

redirect_url: URLField,
created_by: PrimaryKeyRelatedField Help Text

}

created: DateTimeField,
modified: DateTimeField,
title: CharField,
description: CharField,
start_date: DateField,
image: ImageField,
color: CharField,
should_update_color: BooleanField,
is_published: BooleanField,
tags: CharField,

plan: ChoiceField,

Choices

Value	Meaning
free	Free
exclusive	Exclusive

brand: PrimaryKeyRelatedField Help Text

}

translation-locales

/api/v1/translation-locales/

GET POST OPTIONS

List Create Translation Locales

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
name	Name
country_code	Country Code
language_code	Language Code
version	Version
active	Active

Request Fields:

{

name: CharField, Required
country_code: CharField, Required
language_code: CharField, Required
translations: JSONField,
active: BooleanField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
country_code: CharField,
language_code: CharField,
translations: JSONField,
version: CharField,
active: BooleanField

}

/api/v1/translation-locales/flutter/

GET OPTIONS

List Flutter Formatted Translation Locales

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
DjangoModelPermissionsOrAnonReadOnly	Similar to DjangoModelPermissions, except that anonymous users are allowed read-only access.

Param name	Description
created	Created
modified	Modified
name	Name
country_code	Country Code
language_code	Language Code
version	Version
active	Active

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
country_code: CharField,
language_code: CharField,
translations: JSONField,
version: CharField,
active: BooleanField

}

/api/v1/translation-locales/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Translation Locale

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

name: CharField, Required
country_code: CharField, Required
language_code: CharField, Required
translations: JSONField,
active: BooleanField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
country_code: CharField,
language_code: CharField,
translations: JSONField,
version: CharField,
active: BooleanField

}

translation-texts

/api/v1/translation-texts/

GET POST OPTIONS

List Create Translation Texts

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
title	Title
description	Description
active	Active

Request Fields:

{

title: CharField, Required
example: JSONField,
description: CharField,
active: BooleanField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
title: CharField,
example: JSONField,
description: CharField,
active: BooleanField

}

/api/v1/translation-texts/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Translation Text

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

title: CharField, Required
example: JSONField,
description: CharField,
active: BooleanField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
title: CharField,
example: JSONField,
description: CharField,
active: BooleanField

}

locale-translation-texts

/api/v1/locale-translation-texts/

GET POST OPTIONS

List Create Locale Translation Texts

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
locale	Locale
text	Text
translated_text	Translated Text
not_translated	Not Translated
original	Original

Request Fields:

{

translated_text: CharField,
locale: PrimaryKeyRelatedField, Required Help Text
text: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
translated_text: CharField,
locale: PrimaryKeyRelatedField, Help Text
text: PrimaryKeyRelatedField Help Text

}

/api/v1/locale-translation-texts/stats/<str:type>/

GET OPTIONS

List Dynamic Locale Translation Texts Statistics

Open Link

Description
Authentication
Permissions
Filters

Group statistics by:
`type` = {stat_types}

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
locale	Locale
text	Text
translated_text	Translated Text
not_translated	Not Translated
original	Original

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
language: ReadOnlyField,
country_code: ReadOnlyField,
language_code: ReadOnlyField,
original: ReadOnlyField,
original_description: ReadOnlyField,
translated: ReadOnlyField,
is_translated: SerializerMethodField,
created: DateTimeField,
modified: DateTimeField,
translated_text: CharField,
locale: PrimaryKeyRelatedField, Help Text
text: PrimaryKeyRelatedField Help Text

}

/api/v1/locale-translation-texts/<int:pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Locale Translation Text

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

translated_text: CharField,
locale: PrimaryKeyRelatedField, Required Help Text
text: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
translated_text: CharField,
locale: PrimaryKeyRelatedField, Help Text
text: PrimaryKeyRelatedField Help Text

}

Malinks

Rest API Docs`

api

v1

List Exports

Request Fields:

No input data specified

Response Fields:

users

List Create Clients

Signup response includes an access token

Request Fields:

Response Fields:

Retrieve Update Client

Request Fields:

Response Fields:

List Technicians

Request Fields:

No input data specified

Response Fields:

Retrieve Client

Request Fields:

Response Fields:

Clients Forgot Password

Request Fields:

No input data specified

Response Fields:

No output data specified

Clients Reset Password

Request Fields:

Response Fields:

brands

List Create Brand Feed Posts

Request Fields:

Response Fields:

List Create Brand Brand Link Items

Request Fields:

Response Fields:

Retrieve Update Destroy Brand

Request Fields:

Response Fields:

List Create My Brands

Request Fields:

Response Fields:

List Unfolled Brands

Request Fields:

No input data specified

Response Fields:

List Inactive Brands

Request Fields:

No input data specified

Response Fields:

List Create All Brands

Request Fields:

Response Fields:

brand-users

Retrieve Update Destroy Brand User

Request Fields:

Response Fields:

List Create Brand Users

Request Fields:

Response Fields:

brand-link-items

Retrieve Update Destroy Brand Link Item

Request Fields:

Response Fields:

brand-followings

Retrieve Update Destroy Brand Following

Request Fields:

Response Fields:

List Create Brand Followings

Request Fields:

Response Fields:

brand-memberships

Retrieve Update Destroy Brand Membership

Request Fields:

Response Fields:

Retrieve Update Activate Brand Membership

Request Fields:

Response Fields: