Projects
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Query parameters
items_per_pageintegerRequired
Items Per Page
pageintegerRequired
Page Number
reversebooleanOptional
Sorting Order
sortstringOptional
Sorting Key
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/
GET /api/project/info/?items_per_page=1&page=1 HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}
]Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Body
Other propertiesanyOptional
Responses
201
No response body
No content
post/api/project/info/
POST /api/project/info/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1558
{
"account": {
"description": "Car Manufacturing Company",
"account_name": "Tesla",
"region": "Texas",
"vertical": "Automotive",
"segment": "Renewable Energy",
"website_url": "https://www.tesla.com",
"customer": {
"full_name": "Elon Musk",
"email": "elon@test.com",
"phone": "+120112123456",
"user_id": "12121323231"
},
"logo": []
},
"project": {
"project_name": "TestX",
"project_template": {
"template_name": "IT Support",
"template_id": "1224235232",
"template_config": {
"stages": [
{
"stage_id": "1",
"name": "Brainstorming session",
"color": "#FCEAEA",
"status": {
"status_id": 3,
"status_key": "completed",
"status_name": "Completed"
}
},
{
"stage_id": "2",
"name": "Kick-off call",
"color": "#FCEAEA",
"status": {
"status_id": 3,
"status_key": "completed",
"status_name": "Completed"
}
},
{
"stage_id": "3",
"name": "Getting feedback",
"color": "#EEFAF2",
"status": {
"status_id": 2,
"status_key": "in_progress",
"status_name": "In Progress"
}
},
{
"stage_id": "4",
"name": "high fidelity wireframes",
"color": "#FCEAEA",
"status": {
"status_id": 2,
"status_key": "in_progress",
"status_name": "In Progress"
}
},
{
"stage_id": "",
"name": "Test12",
"color": "#e7f1f7",
"status": {
"status_id": "",
"status_key": "",
"status_name": ""
}
}
]
}
},
"start_date": "2024-05-21T18:30:00.000Z",
"due_date": "2025-05-27T18:30:00.000Z",
"forecasted_date": "2025-05-12T18:30:00.000Z",
"show_forecasted_date": true,
"revenue": "1000",
"is_arr": true,
"project_fee": "190012",
"project_owner": {
"is_owner": false,
"first_name": "Anita",
"middle": "Dakota",
"user_id": "2342135",
"last": "Weber",
"profile_image": "assets/images/users/avatar-8.jpg",
"email": "Jett_Emard20@example.com",
"phone_number": "363-334-0768 x413"
}
}
}201
No response body
No content
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/{id}/
GET /api/project/info/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Other propertiesanyOptional
Responses
200
No response body
No content
put/api/project/info/{id}/
PUT /api/project/info/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"name": "Slack",
"description": "A cloud based team communication platform for enterprises"
}200
No response body
No content
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Responses
204
No response body
No content
delete/api/project/info/{id}/
DELETE /api/project/info/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No response body
No content
post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/assign-partner-owner/
POST /api/project/info/{id}/assign-partner-owner/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/custom-fields/
POST /api/project/info/{id}/custom-fields/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}put
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
put/api/project/info/{id}/custom-fields/
PUT /api/project/info/{id}/custom-fields/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}delete
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
field_idstringRequired
idstringRequired
Responses
204
No response body
No content
delete/api/project/info/{id}/custom-fields/{field_id}/
DELETE /api/project/info/{id}/custom-fields/{field_id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No response body
No content
get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/{id}/customer-invite-status/
GET /api/project/info/{id}/customer-invite-status/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/{id}/deal-memory/
GET /api/project/info/{id}/deal-memory/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/deal-memory/detect-topics/
POST /api/project/info/{id}/deal-memory/detect-topics/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/deal-memory/rephrase/
POST /api/project/info/{id}/deal-memory/rephrase/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/deal-memory/save/
POST /api/project/info/{id}/deal-memory/save/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/{id}/partner-invite-status/
GET /api/project/info/{id}/partner-invite-status/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
user_idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/send-customer-invite/{user_id}/
POST /api/project/info/{id}/send-customer-invite/{user_id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/send-customer-invites/
POST /api/project/info/{id}/send-customer-invites/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
user_idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/send-partner-invite/{user_id}/
POST /api/project/info/{id}/send-partner-invite/{user_id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/send-partner-invites/
POST /api/project/info/{id}/send-partner-invites/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/{id}/widget-settings/
GET /api/project/info/{id}/widget-settings/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/widget-settings/
POST /api/project/info/{id}/widget-settings/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}put
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
put/api/project/info/{id}/widget-settings/
PUT /api/project/info/{id}/widget-settings/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Path parameters
idstringRequired
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/{id}/widget-settings/rotate-key/
POST /api/project/info/{id}/widget-settings/rotate-key/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/action/
POST /api/project/info/action/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Query parameters
account_idstringOptional
Account ID
activity_countintegerOptional
Number of activities to fetch
offsetintegerOptional
Offset for pagination
project_idstringOptional
Project ID
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/activities/
GET /api/project/info/activities/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/deals/
GET /api/project/info/deals/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/deals-bulk-delete/
POST /api/project/info/deals-bulk-delete/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Body
ref_deal_idstringOptional
External deal ID (Salesforce ref_deal_id or HubSpot hubspot_deal_id)
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/deals-del-ref/
POST /api/project/info/deals-del-ref/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"ref_deal_id": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/deals-options/
GET /api/project/info/deals-options/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/getduedata/
POST /api/project/info/getduedata/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/milestones/
GET /api/project/info/milestones/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/project_owner/
GET /api/project/info/project_owner/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/remove-partner-org/
POST /api/project/info/remove-partner-org/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/settings/
GET /api/project/info/settings/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/share_context/
GET /api/project/info/share_context/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}get
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
get/api/project/info/summary/
GET /api/project/info/summary/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}post
Authorizations
AuthorizationstringRequired
JWT token obtained from /api/login/. Pass as: Authorization: Bearer
Body
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
Responses
200Success
application/json
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
project_idstring · max: 25Required
project_namestringOptional
descriptionstringOptional
start_datestring · date-timeOptional
due_datestring · date-timeOptional
project_scorestringRead-onlyRequired
tasks_countintegerOptional
milestones_countintegerOptional
is_arrbooleanOptional
revenueintegerOptional
show_forecasted_datebooleanOptional
forecasted_datestring · date-timeOptional
project_feeintegerOptional
project_ownerstringRead-onlyRequired
template_idstringOptional
currency_unitstringRead-onlyRequired
stagesstringRead-onlyRequired
project_teamstringRead-onlyRequired
visible_to_allbooleanOptionalDefault:
trueaccount_idstring · max: 25Optional
insightsstringRead-onlyRequired
current_stagestringRead-onlyRequired
milestone_statusstringRead-onlyRequired
recent_activitiesstringRead-onlyRequired
time_leftstringRead-onlyRequired
time_spentstringRead-onlyRequired
customer_project_ownerstringRead-onlyRequired
partner_orgsstringRead-onlyRequired
project_type_strstringRead-onlyRequired
project_typestringOptional
billing_modelstringOptional
billing_frequencystringOptional
hourly_rateintegerOptional
monthly_rateintegerOptional
expected_onboarding_feeintegerOptional
project_durationintegerOptional
template_namestringRead-onlyRequired
template_descstringRead-onlyRequired
pipeline_idstring · nullableOptional
calculated_revenuestringRead-onlyRequired
object_sourcestringRead-onlyRequired
current_milestone_idstring · nullableOptional
positionintegerOptional
expected_deal_valueintegerOptional
deal_resourcesintegerOptional
contract_durationintegerOptional
pipeline_stagesstringRead-onlyRequired
current_pipe_stagestringRead-onlyRequired
formatted_deal_valuestringRead-onlyRequired
formatted_revenuestringRead-onlyRequired
formatted_other_revenuestringRead-onlyRequired
other_revenuestringRead-onlyRequired
created_bystring · nullableOptional
invite_typestring · nullableOptional
post/api/project/info/update_position/
POST /api/project/info/update_position/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 916
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"visible_to_all": true,
"account_id": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"pipeline_id": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}200Success
{
"project_id": "text",
"project_name": "text",
"description": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"due_date": "2026-01-01T00:00:00.000Z",
"project_score": "text",
"tasks_count": 1,
"milestones_count": 1,
"phase": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"tags": [],
"project_manager": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_arr": true,
"revenue": 1,
"show_forecasted_date": true,
"forecasted_date": "2026-01-01T00:00:00.000Z",
"project_fee": 1,
"project_owner": "text",
"status": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_id": "text",
"currency_unit": "text",
"stages": "text",
"project_team": "text",
"visible_to_all": true,
"account_id": "text",
"insights": "text",
"current_stage": "text",
"milestone_status": "text",
"recent_activities": "text",
"time_left": "text",
"time_spent": "text",
"customer_project_owner": "text",
"partner_orgs": "text",
"project_type_str": "text",
"project_type": "text",
"billing_model": "text",
"billing_frequency": "text",
"hourly_rate": 1,
"monthly_rate": 1,
"expected_onboarding_fee": 1,
"project_duration": 1,
"external_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"template_name": "text",
"template_desc": "text",
"pipeline_id": "text",
"calculated_revenue": "text",
"object_source": "text",
"current_milestone_id": "text",
"position": 1,
"expected_deal_value": 1,
"deal_resources": 1,
"contract_duration": 1,
"pipeline_stages": "text",
"current_pipe_stage": "text",
"formatted_deal_value": "text",
"formatted_revenue": "text",
"formatted_other_revenue": "text",
"other_revenue": "text",
"custom_fields": [],
"created_by": "text",
"invite_type": "text"
}Last updated