Asociaciones API
api
v1 > admin > affiliationexport > create
ViewSet for MembershipExport
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
from_date required | |
to_date required | |
is_active |
v1 > admin > affiliations > update
Affiliation ViewSet for Update Action
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
membership required | |
name | |
is_owner | |
is_active |
v1 > admin > affiliations > partial_update
Affiliation ViewSet for Update Action
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
membership | |
name | |
is_owner | |
is_active |
v1 > admin > affiliations > delete
Affiliation ViewSet for Update Action
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > annualreport > list
ViewSet for annual data on ProductCharge
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
year | |
search | A search term. |
v1 > admin > assignationroles > list
ViewSet for AssignationRole
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > assignationroles > create
ViewSet for AssignationRole
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required |
v1 > admin > assignationroles > delete
ViewSet for AssignationRole
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > assignations > list
ViewSet for Assignation of a Functionary to a Cycle
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
cycle | |
cycle__segment | |
cycle__is_active | |
is_active | |
search | A search term. |
v1 > admin > assignations > create
ViewSet for Assignation of a Functionary to a Cycle
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
cycle required | |
role required |
v1 > admin > assignations > read
ViewSet for Assignation of a Functionary to a Cycle
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
cycle | |
cycle__segment | |
cycle__is_active | |
is_active | |
search | A search term. |
v1 > admin > assignations > update
ViewSet for Assignation of a Functionary to a Cycle
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
cycle | |
cycle__segment | |
cycle__is_active | |
is_active | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
cycle required | |
role required |
v1 > admin > assignations > partial_update
ViewSet for Assignation of a Functionary to a Cycle
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
cycle | |
cycle__segment | |
cycle__is_active | |
is_active | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
cycle | |
role |
v1 > admin > assignations > delete
ViewSet for Assignation of a Functionary to a Cycle
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
cycle | |
cycle__segment | |
cycle__is_active | |
is_active | |
search | A search term. |
v1 > admin > bluebookconsult > list
ViewSet for Blue Book Consult for Admin Panel
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
user_email | |
segment | |
membership_slug | |
created_at__lte | |
created_at__gte | |
search | A search term. |
v1 > admin > bluebookconsult > create
ViewSet for Blue Book Consult for Admin Panel
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_email | |
data required |
v1 > admin > bluebookconsult > export_bluebook_consults
ViewSet for Blue Book Consult for Admin Panel
v1 > admin > bluebookconsult-cars > versions
Get versions for a specific year, brand, and model from external API
v1 > admin > bluebookconsult-motorcycles > brands
A ViewSet for handling Blue Book API for motorcycles (Clase 2)
v1 > admin > bluebookconsult-motorcycles > models
A ViewSet for handling Blue Book API for motorcycles (Clase 2)
v1 > admin > bluebookconsult-motorcycles > result
A ViewSet for handling Blue Book API for motorcycles (Clase 2)
v1 > admin > bluebookconsult-motorcycles > years
A ViewSet for handling Blue Book API for motorcycles (Clase 2)
v1 > admin > bluebookconsults-no-pagination > list
BlueBookConsults ViewSet without pagination
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
user_email | |
segment | |
membership_slug | |
created_at__lte | |
created_at__gte | |
search | A search term. |
v1 > admin > bluebookconsults-no-pagination > create
BlueBookConsults ViewSet without pagination
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_email | |
data required |
v1 > admin > bluebookconsults-no-pagination > export_bluebook_consults
BlueBookConsults ViewSet without pagination
v1 > admin > bulkpurchases > create
Override create to use purchase creation handler
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
product required | |
memberships required |
v1 > admin > comments > list
Membership Comments View Set
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
search | A search term. |
v1 > admin > comments > create
Membership Comments View Set
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership_slug required | |
comment required |
v1 > admin > comments > delete
Membership Comments View Set
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
search | A search term. |
v1 > admin > cyclemultimedia > list
Cycle Multimedia ViewSet for Admin
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
cycle | |
functionary | |
search | A search term. |
v1 > admin > cyclemultimedia > create
Cycle Multimedia ViewSet for Admin
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
functionary | |
user | |
cycle required | |
name required | |
description required | |
file required |
v1 > admin > cyclemultimedia > delete
Cycle Multimedia ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
cycle | |
functionary | |
search | A search term. |
v1 > admin > cycles > list
View Set for Organization's Cycle Administration
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
segment | |
is_active | |
search | A search term. |
v1 > admin > cycles > create
View Set for Organization's Cycle Administration
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
segment required | |
start_date required | |
end_date required | |
descriptor |
v1 > admin > cycles > update
View Set for Organization's Cycle Administration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
is_active | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
segment required | |
start_date required | |
end_date required | |
descriptor |
v1 > admin > cycles > partial_update
View Set for Organization's Cycle Administration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
is_active | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
segment | |
start_date | |
end_date | |
descriptor |
v1 > admin > cycles > delete
View Set for Organization's Cycle Administration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
is_active | |
search | A search term. |
v1 > admin > documents > list
ViewSet for Document on Admin Panel
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
document_type | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
search | A search term. |
v1 > admin > documents > create
ViewSet for Document on Admin Panel
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
document_type required | |
name required | |
comment required | |
valid_until | |
file required | |
status | |
membership required | |
is_approved | |
approval_date |
v1 > admin > documents > read
ViewSet for Document on Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
document_type | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
search | A search term. |
v1 > admin > documents > update
ViewSet for Document on Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
document_type | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
document_type required | |
name required | |
comment required | |
valid_until | |
file required | |
status | |
membership required | |
is_approved | |
approval_date |
v1 > admin > documents > partial_update
ViewSet for Document on Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
document_type | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
document_type | |
name | |
comment | |
valid_until | |
file | |
status | |
membership | |
is_approved | |
approval_date |
v1 > admin > documents > delete
ViewSet for Document on Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
document_type | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
search | A search term. |
v1 > admin > documenttypes > list
ViewSet for Document Type
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > eventimages > create
Event Image ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
image required | |
order |
v1 > admin > eventimages > update
Event Image ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
image required | |
order |
v1 > admin > eventimages > partial_update
Event Image ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | |
image | |
order |
v1 > admin > eventimages > delete
Event Image ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > eventproducts > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
event | |
is_active | |
search | A search term. |
v1 > admin > eventproducts > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
category | |
name | |
price required | |
is_active | |
membership_type | |
segments | |
comment | |
event required | |
description | |
max_amount required | |
only_members | |
max_amount_per_purchase |
v1 > admin > eventproducts > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
event | |
is_active | |
search | A search term. |
v1 > admin > eventproducts > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
event | |
is_active | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
category | |
name | |
price required | |
is_active | |
membership_type | |
segments | |
comment | |
event required | |
description | |
max_amount required | |
only_members | |
max_amount_per_purchase |
v1 > admin > eventproducts > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
event | |
is_active | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
category | |
name | |
price | |
is_active | |
membership_type | |
segments | |
comment | |
event | |
description | |
max_amount | |
only_members | |
max_amount_per_purchase |
v1 > admin > events > list
Event View Set for Admin Users
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
date | |
date__gte | |
date__gt | |
date__lte | |
date__lt | |
hour | |
hour__gte | |
hour__gt | |
hour__lte | |
hour__lt | |
is_active | |
allowed_segments | |
membership | |
purchased | |
search | A search term. |
v1 > admin > events > create
Event View Set for Admin Users
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
description | |
body | |
date required | |
hour required | |
main_image | |
only_members required | |
allowed_memberships | Leave blank for allow all |
allowed_segments | Leave blank for allow all |
max_tickets | |
max_tickets_per_membership | Set null for no limit |
is_active | |
google_maps_address | |
ticket_description_name |
v1 > admin > events > read
Event View Set for Admin Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
date | |
date__gte | |
date__gt | |
date__lte | |
date__lt | |
hour | |
hour__gte | |
hour__gt | |
hour__lte | |
hour__lt | |
is_active | |
allowed_segments | |
membership | |
purchased | |
search | A search term. |
v1 > admin > events > update
Event View Set for Admin Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
date | |
date__gte | |
date__gt | |
date__lte | |
date__lt | |
hour | |
hour__gte | |
hour__gt | |
hour__lte | |
hour__lt | |
is_active | |
allowed_segments | |
membership | |
purchased | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
description | |
body | |
date required | |
hour required | |
main_image | |
only_members required | |
allowed_memberships | Leave blank for allow all |
allowed_segments | Leave blank for allow all |
max_tickets | |
max_tickets_per_membership | Set null for no limit |
is_active | |
google_maps_address | |
ticket_description_name |
v1 > admin > events > partial_update
Event View Set for Admin Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
date | |
date__gte | |
date__gt | |
date__lte | |
date__lt | |
hour | |
hour__gte | |
hour__gt | |
hour__lte | |
hour__lt | |
is_active | |
allowed_segments | |
membership | |
purchased | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | |
description | |
body | |
date | |
hour | |
main_image | |
only_members | |
allowed_memberships | Leave blank for allow all |
allowed_segments | Leave blank for allow all |
max_tickets | |
max_tickets_per_membership | Set null for no limit |
is_active | |
google_maps_address | |
ticket_description_name |
v1 > admin > events > financials
Event View Set for Admin Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v1 > admin > eventticketlimits > create
Event MembershipType Ticket Limits ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
membership_type required | |
amount required |
v1 > admin > eventticketlimits > update
Event MembershipType Ticket Limits ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
membership_type required | |
amount required |
v1 > admin > eventticketlimits > partial_update
Event MembershipType Ticket Limits ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | |
membership_type | |
amount |
v1 > admin > eventticketlimits > delete
Event MembershipType Ticket Limits ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > files > membership_products
ViewSet for File Handling
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
file required | |
organization required | |
membership_type required | |
legal_personality required |
v1 > admin > files > memberships
ViewSet for File Handling
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
file required | |
organization required | |
membership_type required | |
legal_personality required |
v1 > admin > fiscalregimes > list
ViewSet for FiscalRegime
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > functionary > list
ViewSet for Functionary
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > functionary > create
ViewSet for Functionary
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required |
v1 > admin > functionary-no-pagination > list
Functionary ViewSet without pagination
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > functionary-no-pagination > create
Functionary ViewSet without pagination
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required |
v1 > admin > functionary-no-pagination > export_functionaries
Functionary ViewSet without pagination
v1 > admin > identificationcards > list
ViewSet for Identification Card for Admin Panel
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > identificationcards > create
ViewSet for Identification Card for Admin Panel
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
type_of required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > admin > identificationcards > read
ViewSet for Identification Card for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > identificationcards > update
ViewSet for Identification Card for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
type_of required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > admin > identificationcards > partial_update
ViewSet for Identification Card for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership | |
type_of | |
previous | |
uploaded_by | |
id | |
valid_from | |
valid_until | |
person_name | |
is_approved | |
approval_date | |
file |
v1 > admin > identificationcards > delete
ViewSet for Identification Card for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > identificationcards-no-pagination > list
IdentificationCards ViewSet without pagination
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > identificationcards-no-pagination > create
IdentificationCards ViewSet without pagination
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
type_of required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > admin > identificationcards-no-pagination > read
IdentificationCards ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > identificationcards-no-pagination > update
IdentificationCards ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
type_of required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > admin > identificationcards-no-pagination > partial_update
IdentificationCards ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership | |
type_of | |
previous | |
uploaded_by | |
id | |
valid_from | |
valid_until | |
person_name | |
is_approved | |
approval_date | |
file |
v1 > admin > identificationcards-no-pagination > delete
IdentificationCards ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > identificationcardtypes > list
ViewSet for Indentification Card Type for Admin Panel
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > identificationcardtypes > create
ViewSet for Indentification Card Type for Admin Panel
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
key required | |
name required |
v1 > admin > identificationcardtypes > update
ViewSet for Indentification Card Type for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
key required | |
name required |
v1 > admin > identificationcardtypes > partial_update
ViewSet for Indentification Card Type for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
key | |
name |
v1 > admin > identificationcardtypes > delete
ViewSet for Indentification Card Type for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > invoiceexport > create
ViewSet for InvoiceExport
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
from_date required | |
to_date required | |
status |
v1 > admin > invoices > list
ViewSet for Invoice
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
status | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
search | A search term. |
v1 > admin > invoices > create
ViewSet for Invoice
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
product_charges required | |
invoice_configuration required | |
use |
v1 > admin > invoices > read
ViewSet for Invoice
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
status | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
search | A search term. |
v1 > admin > invoices > cancel
ViewSet for Invoice
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v1 > admin > invoices > send_email
ViewSet for Invoice
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
product_charges required | |
invoice_configuration required | |
use |
v1 > admin > invoiceuses > list
ViewSet for InvoiceUse
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > language > list
View Set For Membership Type Administration
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > language > update
View Set For Membership Type Administration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
system_word required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
system_word required | |
verbose_name required | |
plural_verbose_name required |
v1 > admin > language > partial_update
View Set For Membership Type Administration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
system_word required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
system_word | |
verbose_name | |
plural_verbose_name |
v1 > admin > manualpayments > create
ViewSet for ManualPayment
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
payment_method_type required | |
date required | |
amount required | |
concept | |
reference | |
payment_allocations |
v1 > admin > membership-fields > list
Membership Extra Fields View Set for admins
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > membership-fields > create
Membership Extra Fields View Set for admins
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
choices required | |
is_required |
v1 > admin > membership-fields > read
Membership Extra Fields View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > membership-fields > update
Membership Extra Fields View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
choices required | |
is_required |
v1 > admin > membership-fields > partial_update
Membership Extra Fields View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | |
choices | |
is_required |
v1 > admin > membership-fields > delete
Membership Extra Fields View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > membershipaddresses > create
Membership Address ViewSet for Admin
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
raw required | |
street_number | |
internal_number | |
route | |
locality | |
postal_code | |
state | |
state_code | |
country | |
country_code | |
type_of |
v1 > admin > membershipaddresses > update
Membership Address ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
raw required | |
street_number | |
internal_number | |
route | |
locality | |
postal_code | |
state | |
state_code | |
country | |
country_code | |
type_of |
v1 > admin > membershipaddresses > partial_update
Membership Address ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
raw | |
street_number | |
internal_number | |
route | |
locality | |
postal_code | |
state | |
state_code | |
country | |
country_code | |
type_of |
v1 > admin > membershipaddresses > delete
Membership Address ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > membershipdiscounts > list
Discounts ViewSet
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
search | A search term. |
v1 > admin > membershipdiscounts > create
Discounts ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership required | |
percentage | |
max_amount required | |
amount | |
product_categories required | |
start_date required | |
end_date required | |
comments | |
is_active |
v1 > admin > membershipemails > create
Membership Email ViewSet for Admin
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
email required | |
type_of |
v1 > admin > membershipemails > update
Membership Email ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
email required | |
type_of |
v1 > admin > membershipemails > partial_update
Membership Email ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
email | |
type_of |
v1 > admin > membershipemails > delete
Membership Email ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > membershipfiles > list
Membership Files ViewSet
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
status | |
search | A search term. |
v1 > admin > membershipfiles > approve
Membership Files ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status | |
valid_until |
v1 > admin > membershipfiletypes > list
View Set for Membership File Type administration
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > membershipfiletypes > create
View Set for Membership File Type administration
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
membership_type | Leave blank for require to all types |
validity_days |
v1 > admin > membershipphones > create
Membership Phone ViewSet for Admin
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
phone required | |
type_of |
v1 > admin > membershipphones > update
Membership Phone ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
phone required | |
type_of |
v1 > admin > membershipphones > partial_update
Membership Phone ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
phone | |
type_of |
v1 > admin > membershipphones > delete
Membership Phone ViewSet for Admin
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > membershipproducts > list
ViewSet for MembershipProduct
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
renewal_type | |
duration | |
installable_from__lte | |
installable_from__gte | |
installable_until__lte | |
installable_until__gte | |
segments | |
membership | |
purchasable | |
search | A search term. |
v1 > admin > membershipproducts > update
ViewSet for MembershipProduct
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
renewal_type | |
duration | |
installable_from__lte | |
installable_from__gte | |
installable_until__lte | |
installable_until__gte | |
segments | |
membership | |
purchasable | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
installable_from required | |
installable_until required | |
renewal_type required | |
duration required | |
allow_deferred_payments required | |
category | |
name required | |
price required | |
is_active | |
membership_type | |
segments | |
comment |
v1 > admin > membershipproducts > partial_update
ViewSet for MembershipProduct
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
renewal_type | |
duration | |
installable_from__lte | |
installable_from__gte | |
installable_until__lte | |
installable_until__gte | |
segments | |
membership | |
purchasable | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
installable_from | |
installable_until | |
renewal_type | |
duration | |
allow_deferred_payments | |
category | |
name | |
price | |
is_active | |
membership_type | |
segments | |
comment |
v1 > admin > membershiprenewals > list
ViewSet for Membership renewal with minmal data and without pagination
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
type_of | |
segment | |
products__membershipperiod__period_end__lte | |
products__membershipperiod__period_end__gte | |
type | |
search | A search term. |
v1 > admin > memberships > list
Membership Model ViewSet
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
segment | |
type_of | |
holder | |
is_active | |
created_at__date__gte | |
created_at__date__lte | |
search | A search term. |
v1 > admin > memberships > create
Membership Model ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships > read
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
type_of | |
holder | |
is_active | |
created_at__date__gte | |
created_at__date__lte | |
search | A search term. |
v1 > admin > memberships > update
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
type_of | |
holder | |
is_active | |
created_at__date__gte | |
created_at__date__lte | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships > partial_update
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
type_of | |
holder | |
is_active | |
created_at__date__gte | |
created_at__date__lte | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
name | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of | |
segment | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships > activate
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
name | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of | |
segment | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships > add
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships > bulk_register_email
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships > deactivate
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
name | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of | |
segment | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships > referrals
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v1 > admin > memberships > register_email
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | |
user required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships > remove_holder
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
name | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of | |
segment | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships > subsidiaries
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > list
Membership ViewSet without pagination
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
segment | |
type_of | |
holder | |
is_active | |
created_at__date__gte | |
created_at__date__lte | |
search | A search term. |
v1 > admin > memberships-no-pagination > create
Membership ViewSet without pagination
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > read
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
type_of | |
holder | |
is_active | |
created_at__date__gte | |
created_at__date__lte | |
search | A search term. |
v1 > admin > memberships-no-pagination > update
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
type_of | |
holder | |
is_active | |
created_at__date__gte | |
created_at__date__lte | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > partial_update
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
type_of | |
holder | |
is_active | |
created_at__date__gte | |
created_at__date__lte | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
name | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of | |
segment | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > activate
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
name | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of | |
segment | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > add
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > bulk_register_email
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > deactivate
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
name | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of | |
segment | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > referrals
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v1 > admin > memberships-no-pagination > register_email
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | |
user required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > remove_holder
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
name | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of | |
segment | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > memberships-no-pagination > subsidiaries
Membership ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
name required | |
image | |
bio | |
is_active | |
extra_fields | |
tags | |
type_of required | |
segment required | |
users | |
referred_by | |
contact_emails | |
contact_phones | |
contact_addresses | |
register_date | |
membership_id |
v1 > admin > membershiptypes > list
View Set For Membership Type Administration
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > membershiptypes > create
View Set For Membership Type Administration
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
type_of |
v1 > admin > movements > list
ViewSet for movements
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
date__gte | |
date__lte | |
search | A search term. |
v1 > admin > paymentallocationexport > create
ViewSet for PaymentAllocationExport
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
from_date required | |
to_date required |
v1 > admin > paymentintents > create
ViewSet for PaymentIntent
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
payment_method | |
amount required | |
concept | |
payment_allocations |
v1 > admin > paymentmethods > list
Stripe Payment Method ViewSet
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
search | A search term. |
v1 > admin > paymentmethods > create
Stripe Payment Method ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership required | |
token_id required |
v1 > admin > paymentmethods > delete
Stripe Payment Method ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
search | A search term. |
v1 > admin > paymentmethods > toggle_favorite
Toggle is_favorite status for a payment method
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership required | |
token_id required |
v1 > admin > paymentmethodtypes > list
ViewSet for Payment Method Type
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > payments > list
ViewSet for Payments
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
membership__segment | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
search | A search term. |
v1 > admin > payments > read
ViewSet for Payments
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
membership__segment | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
search | A search term. |
v1 > admin > policies > list
ViewSet for Policies for Admin Panel
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > policies > create
ViewSet for Policies for Admin Panel
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > admin > policies > read
ViewSet for Policies for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > policies > update
ViewSet for Policies for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > admin > policies > partial_update
ViewSet for Policies for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership | |
previous | |
uploaded_by | |
id | |
valid_from | |
valid_until | |
person_name | |
is_approved | |
approval_date | |
file |
v1 > admin > policies > delete
ViewSet for Policies for Admin Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > policies-no-pagination > list
Policies ViewSet without pagination
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > policies-no-pagination > create
Policies ViewSet without pagination
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > admin > policies-no-pagination > read
Policies ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > policies-no-pagination > update
Policies ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > admin > policies-no-pagination > partial_update
Policies ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership | |
previous | |
uploaded_by | |
id | |
valid_from | |
valid_until | |
person_name | |
is_approved | |
approval_date | |
file |
v1 > admin > policies-no-pagination > delete
Policies ViewSet without pagination
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
valid_until__gte | |
valid_until__lte | |
status | |
membership | |
is_approved | |
membership__segment | |
search | A search term. |
v1 > admin > pollanswerexports > create
ViewSet for Poll Answer exports
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
poll required |
v1 > admin > pollanswers > list
Admin viewset for Poll Answers
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
poll | |
membership | |
poll__status | |
poll__type_of | |
search | A search term. |
v1 > admin > pollanswers > read
Admin viewset for Poll Answers
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
poll | |
membership | |
poll__status | |
poll__type_of | |
search | A search term. |
v1 > admin > polls > list
Admin viewset for Poll
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
allowed_segments | |
search | A search term. |
v1 > admin > polls > create
Admin viewset for Poll
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
image | |
description required | |
valid_until required | |
type_of required | |
status | |
questions required | |
allowed_segments required |
v1 > admin > polls > mail
Admin viewset for Poll
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
image | |
description required | |
valid_until required | |
type_of required | |
status | |
questions required | |
allowed_segments required |
v1 > admin > polls > read
Admin viewset for Poll
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
allowed_segments | |
search | A search term. |
v1 > admin > polls > update
Admin viewset for Poll
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
allowed_segments | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
image | |
description required | |
valid_until required | |
type_of required | |
status | |
questions required | |
allowed_segments required |
v1 > admin > polls > partial_update
Admin viewset for Poll
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
allowed_segments | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
image | |
description | |
valid_until | |
type_of | |
status | |
questions | |
allowed_segments |
v1 > admin > polls > delete
Admin viewset for Poll
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
type_of | |
valid_until__gte | |
valid_until__lte | |
status | |
allowed_segments | |
search | A search term. |
v1 > admin > polls > results
Admin viewset for Poll
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v1 > admin > productcharges > list
ViewSet for ProductCharge
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
membership__name__icontains | |
membership__segment | |
date__gte | |
date__lte | |
product | |
payment_status | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
product_type | |
search | A search term. |
v1 > admin > productcharges > read
ViewSet for ProductCharge
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
membership__name__icontains | |
membership__segment | |
date__gte | |
date__lte | |
product | |
payment_status | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
product_type | |
search | A search term. |
v1 > admin > productcharges > delete
ViewSet for ProductCharge
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
membership__name__icontains | |
membership__segment | |
date__gte | |
date__lte | |
product | |
payment_status | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
product_type | |
search | A search term. |
v1 > admin > productinvoiceconfiguration > list
ViewSet for ProductInvoiceConfiguration
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
for_membership | |
for_event | |
for_stock | |
product_key | |
search | A search term. |
v1 > admin > productinvoiceconfiguration > create
ViewSet for ProductInvoiceConfiguration
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
product | |
uses required | |
description required | |
product_key required | |
unit_key required | |
for_membership | |
for_event | |
for_stock | |
tax_included | |
taxability |
v1 > admin > productinvoiceconfiguration > read
ViewSet for ProductInvoiceConfiguration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
for_membership | |
for_event | |
for_stock | |
product_key | |
search | A search term. |
v1 > admin > productinvoiceconfiguration > update
ViewSet for ProductInvoiceConfiguration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
for_membership | |
for_event | |
for_stock | |
product_key | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
product | |
uses required | |
description required | |
product_key required | |
unit_key required | |
for_membership | |
for_event | |
for_stock | |
tax_included | |
taxability |
v1 > admin > productinvoiceconfiguration > partial_update
ViewSet for ProductInvoiceConfiguration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
for_membership | |
for_event | |
for_stock | |
product_key | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
product | |
uses | |
description | |
product_key | |
unit_key | |
for_membership | |
for_event | |
for_stock | |
tax_included | |
taxability |
v1 > admin > productinvoiceconfiguration > delete
ViewSet for ProductInvoiceConfiguration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
for_membership | |
for_event | |
for_stock | |
product_key | |
search | A search term. |
v1 > admin > productpricevariations > list
ViewSet for ProductPriceVariations
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
product | |
membership_type | |
segments | |
search | A search term. |
v1 > admin > productpricevariations > create
ViewSet for ProductPriceVariations
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
product | |
price_variation required | |
membership_type required | |
segments required | |
is_active | |
min_amount | |
max_amount | |
comment |
v1 > admin > productpricevariations > read
ViewSet for ProductPriceVariations
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required | A unique value identifying this product price variation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
product | |
membership_type | |
segments | |
search | A search term. |
v1 > admin > productpricevariations > update
ViewSet for ProductPriceVariations
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required | A unique value identifying this product price variation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
product | |
membership_type | |
segments | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
product | |
price_variation required | |
membership_type required | |
segments required | |
is_active | |
min_amount | |
max_amount | |
comment |
v1 > admin > productpricevariations > partial_update
ViewSet for ProductPriceVariations
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required | A unique value identifying this product price variation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
product | |
membership_type | |
segments | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
product | |
price_variation | |
membership_type | |
segments | |
is_active | |
min_amount | |
max_amount | |
comment |
v1 > admin > products > list
Product ViewSet
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
invoice_configuration__isnull | |
product_type | |
search | A search term. |
v1 > admin > products > read
Product ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
invoice_configuration__isnull | |
product_type | |
search | A search term. |
v1 > admin > purchases > list
Product Purchase View Set
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > purchases > create
Override create to use purchase creation handler
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
product required | |
quantity | |
installments | |
owner_relation |
v1 > admin > questionoptions > create
Admin viewset for Poll choice question options
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
choice_question | |
order | |
text required |
v1 > admin > questionoptions > update
Admin viewset for Poll choice question options
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
choice_question | |
order | |
text required |
v1 > admin > questionoptions > partial_update
Admin viewset for Poll choice question options
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
choice_question | |
order | |
text |
v1 > admin > questionoptions > delete
Admin viewset for Poll choice question options
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > questions > update
Admin viewset for Poll questions
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > questions > partial_update
Admin viewset for Poll questions
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > questions > delete
Admin viewset for Poll questions
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > segments > list
View Set for Organization's Segment Administration
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > segments > create
View Set for Organization's Segment Administration
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent | |
name required | |
comment |
v1 > admin > segments > read
View Set for Organization's Segment Administration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > segments > delete
View Set for Organization's Segment Administration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > segments > activate
View Set for Organization's Segment Administration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent | |
name | |
comment |
v1 > admin > segments > deactivate
View Set for Organization's Segment Administration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent | |
name | |
comment |
v1 > admin > tag-categories > list
Membership Tag Categories View Set for admins
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > tag-categories > create
Membership Tag Categories View Set for admins
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required |
v1 > admin > tag-categories > read
Membership Tag Categories View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > tag-categories > update
Membership Tag Categories View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required |
v1 > admin > tag-categories > partial_update
Membership Tag Categories View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name |
v1 > admin > tag-categories > delete
Membership Tag Categories View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > tags > list
Membership Tags View Set for admins
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > tags > create
Membership Tags View Set for admins
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
category_name required |
v1 > admin > tags > read
Membership Tags View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > tags > update
Membership Tags View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
category_name required |
v1 > admin > tags > partial_update
Membership Tags View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | |
category_name |
v1 > admin > tags > delete
Membership Tags View Set for admins
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > admin > termsacceptance > list
Terms Acceptance view for functionaries
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > admin > termsacceptance > create
Terms Acceptance view for functionaries
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
terms_name required |
v1 > admin > tickets > list
Event Tickets View Set for Admin Users
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
event | |
checked_in | |
search | A search term. |
v1 > admin > tickets > read
Event Tickets View Set for Admin Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
event | |
checked_in | |
search | A search term. |
v1 > admin > tickets > update
Event Tickets View Set for Admin Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
event | |
checked_in | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
membership | |
first_name | |
last_name | |
email | |
phone | |
description | |
checked_in |
v1 > admin > tickets > partial_update
Event Tickets View Set for Admin Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
event | |
checked_in | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | |
membership | |
first_name | |
last_name | |
email | |
phone | |
description | |
checked_in |
v1 > admin > tickets > checkin
Event Tickets View Set for Admin Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
membership | |
first_name | |
last_name | |
email | |
phone | |
description | |
checked_in |
v1 > admin > users > create
Django User Model ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
password |
v1 > admin > users > confirm
Django User Model ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
password |
v1 > admin > users > reset
Django User Model ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
password |
v1 > admin > users > inactivate
Django User Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this user. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
password |
v1 > admin > volumediscounts > list
VolumeDiscount ViewSet
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
product | |
search | A search term. |
v1 > admin > volumediscounts > create
VolumeDiscount ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
percentage | |
max_amount required | |
amount | |
product required | |
min_purchase required | |
max_purchase required | |
is_active |
v1 > admin > volumediscounts > update
VolumeDiscount ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
product | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
percentage | |
max_amount required | |
amount | |
product required | |
min_purchase required | |
max_purchase required | |
is_active |
v1 > admin > volumediscounts > partial_update
VolumeDiscount ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
product | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
percentage | |
max_amount | |
amount | |
product | |
min_purchase | |
max_purchase | |
is_active |
v1 > admin > volumediscounts > delete
VolumeDiscount ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
product | |
search | A search term. |
v1 > auth > create
Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
password required |
v1 > auth > refresh > create
Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
refresh required |
v1 > member > assignations > list
ViewSet for Assignations for Member
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
cycle | |
cycle__segment | |
functionary | |
is_active | |
search | A search term. |
v1 > member > cyclemultimedia > list
View Set for Member/Functionary for CycleMultimedia
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
cycle__segment | |
cycle | |
functionary | |
search | A search term. |
v1 > member > cyclemultimedia > create
View Set for Member/Functionary for CycleMultimedia
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
functionary | |
user | |
cycle required | |
name required | |
description required | |
file required |
v1 > member > cycles > list
View Set for Member for Cycles
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
segment | |
search | A search term. |
v1 > member > directory > list
Directory memberships view for member
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
segment | |
bio | |
search | A search term. |
v1 > member > directory > read
Directory memberships view for member
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
segment | |
bio | |
search | A search term. |
v1 > member > documents > list
ViewSet for Document on Member Panel
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > documents > create
ViewSet for Document on Member Panel
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
document_type required | |
name required | |
comment required | |
valid_until | |
file required | |
status | |
membership required | |
is_approved | |
approval_date |
v1 > member > documents > read
ViewSet for Document on Member Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > documents > delete
ViewSet for Document on Member Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > documenttypes > list
ViewSet for Document Type
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > eventproducts > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
event | |
is_active | |
membership | |
search | A search term. |
v1 > member > eventproducts > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required | A unique value identifying this event product. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
event | |
is_active | |
membership | |
search | A search term. |
v1 > member > eventpurchase > create
Override create to use purchase creation handler and create payment
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership required | |
email required | |
product required | |
quantity required | |
payment_method required | |
ticket_owner required |
v1 > member > events > list
Event View Set for Member Users
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
date | |
date__gte | |
date__gt | |
date__lte | |
date__lt | |
hour | |
hour__gte | |
hour__gt | |
hour__lte | |
hour__lt | |
is_active | |
allowed_segments | |
membership | |
purchased | |
search | A search term. |
v1 > member > events > read
Event View Set for Member Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required | A unique value identifying this event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
date | |
date__gte | |
date__gt | |
date__lte | |
date__lt | |
hour | |
hour__gte | |
hour__gt | |
hour__lte | |
hour__lt | |
is_active | |
allowed_segments | |
membership | |
purchased | |
search | A search term. |
v1 > member > identificationcards > list
ViewSet for Identification Card on Member Panel
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > identificationcards > create
ViewSet for Identification Card on Member Panel
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
type_of required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > member > identificationcards > read
ViewSet for Identification Card on Member Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > identificationcards > delete
ViewSet for Identification Card on Member Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > identificationcardtypes > list
ViewSet for Identification Card Type for Member Panel
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > invoices > list
ViewSet for Member Invoice
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
status | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
search | A search term. |
v1 > member > invoices > read
ViewSet for Member Invoice
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
status | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
search | A search term. |
v1 > member > membership-addresses > create
Membership Addresss ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
raw required | |
street_number | |
internal_number | |
route | |
locality | |
postal_code | |
state | |
state_code | |
country | |
country_code | |
type_of |
v1 > member > membership-addresses > update
Membership Addresss ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
raw required | |
street_number | |
internal_number | |
route | |
locality | |
postal_code | |
state | |
state_code | |
country | |
country_code | |
type_of |
v1 > member > membership-addresses > partial_update
Membership Addresss ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
raw | |
street_number | |
internal_number | |
route | |
locality | |
postal_code | |
state | |
state_code | |
country | |
country_code | |
type_of |
v1 > member > membership-addresses > delete
Membership Addresss ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > membership-emails > create
Membership Emails ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
email required | |
type_of |
v1 > member > membership-emails > update
Membership Emails ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
email required | |
type_of |
v1 > member > membership-emails > partial_update
Membership Emails ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
email | |
type_of |
v1 > member > membership-emails > delete
Membership Emails ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > membership-phones > create
Membership Phones ViewSet
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
phone required | |
type_of |
v1 > member > membership-phones > update
Membership Phones ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
phone required | |
type_of |
v1 > member > membership-phones > partial_update
Membership Phones ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
phone | |
type_of |
v1 > member > membership-phones > delete
Membership Phones ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > membershipinvoiceconfiguration > list
ViewSet for MembershipInvoiceConfiguration
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > membershipinvoiceconfiguration > create
ViewSet for MembershipInvoiceConfiguration
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership required | |
tax_system required | |
legal_name required | |
email required | |
tax_id required | |
zip_code required | |
default |
v1 > member > membershipinvoiceconfiguration > update
ViewSet for MembershipInvoiceConfiguration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership required | |
tax_system required | |
legal_name required | |
email required | |
tax_id required | |
zip_code required | |
default |
v1 > member > membershipinvoiceconfiguration > partial_update
ViewSet for MembershipInvoiceConfiguration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
tax_system | |
legal_name | |
email | |
tax_id | |
zip_code | |
default |
v1 > member > membershipinvoiceconfiguration > delete
ViewSet for MembershipInvoiceConfiguration
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > memberships > list
Membership Model ViewSet
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > memberships > read
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > memberships > update
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
users | |
type_of required | |
segment required | |
referred_by | |
image | |
bio | |
referral_id | |
visibility |
v1 > member > memberships > partial_update
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
users | |
type_of | |
segment | |
referred_by | |
image | |
bio | |
referral_id | |
visibility |
v1 > member > memberships > contacts
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v1 > member > memberships > subsidiaries
Membership Model ViewSet
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v1 > member > paymentintents > create
ViewSet for Member PaymentIntent
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
payment_method | |
concept | |
payment_allocations | |
product_charges required |
v1 > member > paymentmethods > list
Viewset for Member Payment Methods
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > paymentmethods > create
Viewset for Member Payment Methods
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership required | |
token_id required |
v1 > member > paymentmethods > read
Viewset for Member Payment Methods
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > paymentmethods > delete
Viewset for Member Payment Methods
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > payments > list
ViewSet for Member Payments
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
membership__segment | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
search | A search term. |
v1 > member > payments > read
ViewSet for Member Payments
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
membership__segment | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
search | A search term. |
v1 > member > policies > list
ViewSet for Policies on Member Panel
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > policies > create
ViewSet for Policies on Member Panel
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization | |
membership required | |
previous | |
uploaded_by | |
id required | |
valid_from required | |
valid_until required | |
person_name required | |
is_approved | |
approval_date | |
file required |
v1 > member > policies > read
ViewSet for Policies on Member Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > policies > delete
ViewSet for Policies on Member Panel
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > pollanswers > list
Member viewset for Poll Answers
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > pollanswers > create
Member viewset for Poll Answers
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
poll required | |
membership required | |
answers required |
v1 > member > pollanswers > read
Member viewset for Poll Answers
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
poll required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > polls > list
Member viewset for Polls
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > polls > read
Member viewset for Polls
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > productcharges > list
ViewSet for Member ProductCharge
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
membership | |
membership__name__icontains | |
membership__segment | |
date__gte | |
date__lte | |
product | |
payment_status | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
product_type | |
search | A search term. |
v1 > member > productcharges > read
ViewSet for Member ProductCharge
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
membership | |
membership__name__icontains | |
membership__segment | |
date__gte | |
date__lte | |
product | |
payment_status | |
created_at__lte | |
created_at__gte | |
updated_at__lte | |
updated_at__gte | |
product_type | |
search | A search term. |
v1 > member > segments > list
View Set for member segment view
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > tickets > list
Event Ticket View Set for Member User
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > tickets > read
Event Ticket View Set for Member User
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > member > tickets > update
Event Ticket View Set for Member User
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
membership | |
first_name | |
last_name | |
email | |
phone | |
description | |
checked_in |
v1 > member > tickets > partial_update
Event Ticket View Set for Member User
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | |
membership | |
first_name | |
last_name | |
email | |
phone | |
description | |
checked_in |
v1 > member > users > list
Affiliations viewset for member user
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
search | A search term. |
v1 > member > users > create
Affiliations viewset for member user
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
membership required | |
name | |
is_owner | |
is_active |
v1 > member > users > update
Affiliations viewset for member user
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
membership required | |
name | |
is_owner | |
is_active |
v1 > member > users > partial_update
Affiliations viewset for member user
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
membership | |
name | |
is_owner | |
is_active |
v1 > member > users > delete
Affiliations viewset for member user
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > public > checkoutsessions > create
ViewSet for Checkout Session
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
product required | |
success_url required | |
cancel_url required | |
quantity required | |
ticket_owner required | |
product_charge |
v1 > public > checkoutsessions > read
ViewSet for Checkout Session
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required | A unique value identifying this checkout session. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > public > eventproducts > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
event | |
search | A search term. |
v1 > public > eventproducts > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required | A unique value identifying this event product. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
event | |
search | A search term. |
v1 > public > events > list
Event View Set for Anonymous Users
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
is_active | |
search | A search term. |
v1 > public > events > read
Event View Set for Anonymous Users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required | A unique value identifying this event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
is_active | |
search | A search term. |
v1 > public > invoices > create
Public ViewSet for Invoice without access token
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
membership | |
product_charges required | |
invoice_configuration required | |
use |
v1 > public > productcharges > read
Publice ViewSet for ProductCharge without access token
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required | A unique value identifying this product charge. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
v1 > public > tickets > read
Public Ticket View Set
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
facturapi
membership
check > read
Check if a membership is active by random_slug
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
random_slug required |