For the complete documentation index, see llms.txt. This page is also available as Markdown.

Users

All Users

get

This endpoint is used to fetch all users in the current organization

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
get/api/users/profile/
GET /api/users/profile/?items_per_page=1&page=1 HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
  {
    "profile_id": "text",
    "user_id": "text",
    "phone_no": "text",
    "designation": "text",
    "tags": [],
    "email": "text",
    "role_id": "text",
    "is_demo_data": true,
    "invite_token": "text",
    "organization": "text",
    "background_image": "text",
    "profile_image": "text",
    "projects": "text",
    "tasks": "text",
    "full_name": "text",
    "role": "text",
    "cover_image": "text",
    "joining_date": "2026-01-01",
    "is_active": "text",
    "is_fir_login": "text",
    "deals": "text",
    "department": "text",
    "reports_to": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "is_team_head": true
  }
]

Gets a user detail with the given id

get

This endpoint is used to fetch a user profile for the current organization

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
get/api/users/profile/{id}/
GET /api/users/profile/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}

Edits the user with the given id

put

This endpoint is used to edit an user for the current organization

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/users/profile/{id}/
PUT /api/users/profile/{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

Deletes the user with the given id

delete

This endpoint is used to delete an user for the current organization

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
204

No response body

No content

delete/api/users/profile/{id}/
DELETE /api/users/profile/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No response body

No content

post

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
post/api/users/profile/action/
POST /api/users/profile/action/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "profile_id": "text",
  "user_id": "text",
  "designation": "text",
  "tags": [],
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "joining_date": "2026-01-01",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
get

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
get/api/users/profile/activity/
GET /api/users/profile/activity/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
post

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
post/api/users/profile/attachfile/
POST /api/users/profile/attachfile/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "profile_id": "text",
  "user_id": "text",
  "designation": "text",
  "tags": [],
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "joining_date": "2026-01-01",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}

Get Customer Details

get

This endpoint is used to get all customer users in the organization with their details including name, designation, email, joining date, is_first_login, mapped projects, and mapped deals

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses
200

No response body

No content

get/api/users/profile/cus-details/
GET /api/users/profile/cus-details/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Adds a customer invite

post

This endpoint is used to add a customer invite which creates an organization customer role for the given email and associates it with a list of project or deal IDs

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body
Other propertiesanyOptional
Responses
201

No response body

No content

post/api/users/profile/cus-invite/
POST /api/users/profile/cus-invite/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "email": "customer@example.com",
  "full_name": "John Doe",
  "project_ids": [
    "proj123",
    "proj456"
  ],
  "deal_ids": [
    "deal789"
  ]
}
201

No response body

No content

Update Customer Project Mapping

post

This endpoint updates the project mapping for a customer user based on the given user_id and list of project_ids. If the list is empty, all projects are removed from that customer.

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body
Other propertiesanyOptional
Responses
200

No response body

No content

post/api/users/profile/cus-project-map/
POST /api/users/profile/cus-project-map/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "user_id": "usr_12345",
  "project_ids": [
    "proj_1",
    "proj_2",
    "deal_3"
  ]
}
200

No response body

No content

Deletes a designation

post

This endpoint is used to delete a designation

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body
Other propertiesanyOptional
Responses
200

No response body

No content

post/api/users/profile/del_designation/
POST /api/users/profile/del_designation/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "value": "Senior Dev"
}
200

No response body

No content

get

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
get/api/users/profile/department-options/
GET /api/users/profile/department-options/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}

Updates a designation name

post

This endpoint is used to update the name of a designation

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body
Other propertiesanyOptional
Responses
200

No response body

No content

post/api/users/profile/designation/
POST /api/users/profile/designation/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "value": "Senior Dev",
  "name": "Senior Developer",
  "previous_name": "Senior Dev"
}
200

No response body

No content

Get Designation Options

get

This endpoint is used to get the list of designations for the current organization

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
get/api/users/profile/designation-options/
GET /api/users/profile/designation-options/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
get

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
get/api/users/profile/get_notify_pre/
GET /api/users/profile/get_notify_pre/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
post

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
post/api/users/profile/login-session/
POST /api/users/profile/login-session/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "profile_id": "text",
  "user_id": "text",
  "designation": "text",
  "tags": [],
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "joining_date": "2026-01-01",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
post

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
post/api/users/profile/logout/
POST /api/users/profile/logout/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "profile_id": "text",
  "user_id": "text",
  "designation": "text",
  "tags": [],
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "joining_date": "2026-01-01",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
post

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
post/api/users/profile/re-invite/
POST /api/users/profile/re-invite/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "profile_id": "text",
  "user_id": "text",
  "designation": "text",
  "tags": [],
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "joining_date": "2026-01-01",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
post

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
post/api/users/profile/rolemap/
POST /api/users/profile/rolemap/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "profile_id": "text",
  "user_id": "text",
  "designation": "text",
  "tags": [],
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "joining_date": "2026-01-01",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
post

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
post/api/users/profile/save_notify_pre/
POST /api/users/profile/save_notify_pre/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "profile_id": "text",
  "user_id": "text",
  "designation": "text",
  "tags": [],
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "joining_date": "2026-01-01",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}
get

API endpoint that allows users to be created, viewed, deleted or edited.

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.

profile_idstring · max: 25Required
user_idstringOptional
phone_nostringRead-onlyRequired
designationstring · nullableOptional
emailstringRead-onlyRequired
role_idstringRead-onlyRequired
is_demo_databooleanOptional
invite_tokenstring · nullableOptional
organizationstring · max: 25Required
background_imagestringRead-onlyRequired
profile_imagestringRead-onlyRequired
projectsstringRead-onlyRequired
tasksstringRead-onlyRequired
full_namestringRead-onlyRequired
rolestringRead-onlyRequired
cover_imagestringRead-onlyRequired
joining_datestring · date · nullableOptional
is_activestringRead-onlyRequired
is_fir_loginstringRead-onlyRequired
dealsstringRead-onlyRequired
departmentstring · nullableOptional
is_team_headbooleanOptional
get/api/users/profile/user_option/
GET /api/users/profile/user_option/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "profile_id": "text",
  "user_id": "text",
  "phone_no": "text",
  "designation": "text",
  "tags": [],
  "email": "text",
  "role_id": "text",
  "is_demo_data": true,
  "invite_token": "text",
  "organization": "text",
  "background_image": "text",
  "profile_image": "text",
  "projects": "text",
  "tasks": "text",
  "full_name": "text",
  "role": "text",
  "cover_image": "text",
  "joining_date": "2026-01-01",
  "is_active": "text",
  "is_fir_login": "text",
  "deals": "text",
  "department": "text",
  "reports_to": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_team_head": true
}

Last updated