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

Accounts

All Accounts

get

This endpoint is used to fetch all accounts 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · nullableOptional
get/api/account/info/
GET /api/account/info/?items_per_page=1&page=1 HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
  {
    "account_id": "text",
    "account_name": "text",
    "description": "text",
    "account_owner": "text",
    "linked_projects": "text",
    "health_score": "text",
    "total_revenue": "text",
    "total_projects": "text",
    "completed_projects": "text",
    "total_deals": "text",
    "completed_deals": "text",
    "vertical": "text",
    "segment": "text",
    "website_url": "text",
    "region": "text",
    "customer": "text",
    "is_favourite": true,
    "currency_unit": "text",
    "logo_path": "text",
    "logo": "text",
    "insight": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "total_formatted_revenue": "text",
    "is_internal_account": true,
    "company_id": "text"
  }
]

Creates a new account

post

This endpoint is used to save a new account for the current organization

Authorizations
AuthorizationstringRequired

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

Body
Other propertiesanyOptional
Responses
201

No response body

No content

post/api/account/info/
POST /api/account/info/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "name": "Slack",
  "description": "A cloud based team communication platform",
  "account_owner": {
    "name": "Shyam",
    "id": "123"
  },
  "link_projects": [
    {
      "project": "Creation of ticket",
      "project_id": "PR123"
    },
    {
      "project": "Creation of request",
      "project_id": "PR124"
    }
  ],
  "health_score": 10,
  "total_revenue": 10000,
  "logo_path": ""
}
201

No response body

No content

Gets a account with the given id

get

This endpoint is used to fetch a account details 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · nullableOptional
get/api/account/info/{id}/
GET /api/account/info/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "account_owner": "text",
  "linked_projects": "text",
  "health_score": "text",
  "total_revenue": "text",
  "total_projects": "text",
  "completed_projects": "text",
  "total_deals": "text",
  "completed_deals": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "customer": "text",
  "is_favourite": true,
  "currency_unit": "text",
  "logo_path": "text",
  "logo": "text",
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "total_formatted_revenue": "text",
  "is_internal_account": true,
  "company_id": "text"
}

Edits the account with the given id

put

This endpoint is used to edit an account 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/account/info/{id}/
PUT /api/account/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

Deletes the account with the given id

delete

This endpoint is used to delete an account 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/account/info/{id}/
DELETE /api/account/info/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No response body

No content

get

API endpoint that allows accounts 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · nullableOptional
get/api/account/info/all-accounts/
GET /api/account/info/all-accounts/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "account_owner": "text",
  "linked_projects": "text",
  "health_score": "text",
  "total_revenue": "text",
  "total_projects": "text",
  "completed_projects": "text",
  "total_deals": "text",
  "completed_deals": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "customer": "text",
  "is_favourite": true,
  "currency_unit": "text",
  "logo_path": "text",
  "logo": "text",
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "total_formatted_revenue": "text",
  "is_internal_account": true,
  "company_id": "text"
}
post

API endpoint that allows accounts 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · nullableOptional
post/api/account/info/del_vertical/
POST /api/account/info/del_vertical/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "is_favourite": true,
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_internal_account": true,
  "company_id": "text"
}
200Success
{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "account_owner": "text",
  "linked_projects": "text",
  "health_score": "text",
  "total_revenue": "text",
  "total_projects": "text",
  "completed_projects": "text",
  "total_deals": "text",
  "completed_deals": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "customer": "text",
  "is_favourite": true,
  "currency_unit": "text",
  "logo_path": "text",
  "logo": "text",
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "total_formatted_revenue": "text",
  "is_internal_account": true,
  "company_id": "text"
}
get

API endpoint that allows accounts 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · nullableOptional
get/api/account/info/journey/
GET /api/account/info/journey/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "account_owner": "text",
  "linked_projects": "text",
  "health_score": "text",
  "total_revenue": "text",
  "total_projects": "text",
  "completed_projects": "text",
  "total_deals": "text",
  "completed_deals": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "customer": "text",
  "is_favourite": true,
  "currency_unit": "text",
  "logo_path": "text",
  "logo": "text",
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "total_formatted_revenue": "text",
  "is_internal_account": true,
  "company_id": "text"
}
get

API endpoint that allows accounts 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · nullableOptional
get/api/account/info/more-activities/
GET /api/account/info/more-activities/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "account_owner": "text",
  "linked_projects": "text",
  "health_score": "text",
  "total_revenue": "text",
  "total_projects": "text",
  "completed_projects": "text",
  "total_deals": "text",
  "completed_deals": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "customer": "text",
  "is_favourite": true,
  "currency_unit": "text",
  "logo_path": "text",
  "logo": "text",
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "total_formatted_revenue": "text",
  "is_internal_account": true,
  "company_id": "text"
}
get

API endpoint that allows accounts 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · nullableOptional
get/api/account/info/options/
GET /api/account/info/options/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "account_owner": "text",
  "linked_projects": "text",
  "health_score": "text",
  "total_revenue": "text",
  "total_projects": "text",
  "completed_projects": "text",
  "total_deals": "text",
  "completed_deals": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "customer": "text",
  "is_favourite": true,
  "currency_unit": "text",
  "logo_path": "text",
  "logo": "text",
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "total_formatted_revenue": "text",
  "is_internal_account": true,
  "company_id": "text"
}
get

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

Authorizations
AuthorizationstringRequired

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

Path parameters
idstringRequiredPattern: ^[^/]+$
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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · nullableOptional
get/api/account/info/overview/{id}/
GET /api/account/info/overview/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "account_owner": "text",
  "linked_projects": "text",
  "health_score": "text",
  "total_revenue": "text",
  "total_projects": "text",
  "completed_projects": "text",
  "total_deals": "text",
  "completed_deals": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "customer": "text",
  "is_favourite": true,
  "currency_unit": "text",
  "logo_path": "text",
  "logo": "text",
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "total_formatted_revenue": "text",
  "is_internal_account": true,
  "company_id": "text"
}
post

API endpoint that allows accounts 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · 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.

account_idstring · max: 25Required
account_namestringOptional
descriptionstringOptional
account_ownerstringRead-onlyRequired
linked_projectsstringRead-onlyRequired
health_scorestringRead-onlyRequired
total_revenuestringRead-onlyRequired
total_projectsstringRead-onlyRequired
completed_projectsstringRead-onlyRequired
total_dealsstringRead-onlyRequired
completed_dealsstringRead-onlyRequired
verticalstringOptional
segmentstringOptional
website_urlstringOptional
regionstringOptional
customerstringRead-onlyRequired
is_favouritebooleanOptional
currency_unitstringRead-onlyRequired
logo_pathstringRead-onlyRequired
logostringRead-onlyRequired
total_formatted_revenuestringRead-onlyRequired
is_internal_accountbooleanOptional
company_idstring · nullableOptional
post/api/account/info/vertical/
POST /api/account/info/vertical/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "is_favourite": true,
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_internal_account": true,
  "company_id": "text"
}
200Success
{
  "account_id": "text",
  "account_name": "text",
  "description": "text",
  "account_owner": "text",
  "linked_projects": "text",
  "health_score": "text",
  "total_revenue": "text",
  "total_projects": "text",
  "completed_projects": "text",
  "total_deals": "text",
  "completed_deals": "text",
  "vertical": "text",
  "segment": "text",
  "website_url": "text",
  "region": "text",
  "customer": "text",
  "is_favourite": true,
  "currency_unit": "text",
  "logo_path": "text",
  "logo": "text",
  "insight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "total_formatted_revenue": "text",
  "is_internal_account": true,
  "company_id": "text"
}

Last updated