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

Companies

All Companies

get

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

idstringRead-onlyRequired
company_idstringRequired
display_idstring · max: 100 · nullableOptional
company_namestring · max: 255Required
domainstring · nullableOptional
linkedin_urlstringRead-onlyRequired
twitter_urlstringRead-onlyRequired
hq_locationstringRead-onlyRequired
hq_countrystringRead-onlyRequired
industrystringRead-onlyRequired
employee_rangestring · nullableOptional
estimated_arrstringRead-onlyRequired
descriptionstring · nullableOptional
logo_urlstringRead-onlyRequired
company_ownerstringRead-onlyRequired
company_typestring · nullableOptional
lead_statusstringRead-onlyRequired
icp_fitstring · nullableOptional
customer_segmentstringRead-onlyRequired
connection_strengthstring · nullableOptional
connection_sourcestring · nullableOptional
operating_regionsstringRead-onlyRequired
categorystring · nullableOptional
vendor_being_replacedstring · nullableOptional
replacement_urgencystring · nullableOptional
partner_typestringRead-onlyRequired
parent_companystring · nullableOptional
investorsstringRead-onlyRequired
partnersstringRead-onlyRequired
subsidiariesstringRead-onlyRequired
contacts_countstringRead-onlyRequired
is_draftbooleanOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
record_sourcestringRead-onlyRequired
associated_deal_projectstringRead-onlyRequired
get/api/company/
GET /api/company/?items_per_page=1&page=1 HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
  {
    "id": "text",
    "company_id": "text",
    "display_id": "text",
    "company_name": "text",
    "domain": "text",
    "linkedin_url": "text",
    "twitter_url": "text",
    "hq_location": "text",
    "hq_country": "text",
    "industry": "text",
    "employee_range": "text",
    "estimated_arr": "text",
    "description": "text",
    "logo_url": "text",
    "company_owner": "text",
    "company_type": "text",
    "lead_status": "text",
    "icp_fit": "text",
    "customer_segment": "text",
    "connection_strength": "text",
    "connection_source": "text",
    "operating_regions": "text",
    "category": "text",
    "vendor_being_replaced": "text",
    "replacement_urgency": "text",
    "partner_type": "text",
    "parent_company": "text",
    "investors": "text",
    "partners": "text",
    "subsidiaries": "text",
    "contacts_count": "text",
    "is_draft": true,
    "creation_time": "2026-01-01T00:00:00.000Z",
    "last_update_time": "2026-01-01T00:00:00.000Z",
    "record_source": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "associated_deal_project": "text"
  }
]

Creates a new company

post

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

Authorizations
AuthorizationstringRequired

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

Body
Other propertiesanyOptional
Responses
200

No response body

No content

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

{
  "company_name": "Acme Corporation",
  "domain": "acme.com"
}
200

No response body

No content

Gets a company with the given id

get

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

idstringRead-onlyRequired
company_idstringRequired
display_idstring · max: 100 · nullableOptional
company_namestring · max: 255Required
domainstring · nullableOptional
linkedin_urlstringRead-onlyRequired
twitter_urlstringRead-onlyRequired
hq_locationstringRead-onlyRequired
hq_countrystringRead-onlyRequired
industrystringRead-onlyRequired
employee_rangestring · nullableOptional
estimated_arrstringRead-onlyRequired
descriptionstring · nullableOptional
logo_urlstringRead-onlyRequired
company_ownerstringRead-onlyRequired
company_typestring · nullableOptional
lead_statusstringRead-onlyRequired
icp_fitstring · nullableOptional
customer_segmentstringRead-onlyRequired
connection_strengthstring · nullableOptional
connection_sourcestring · nullableOptional
operating_regionsstringRead-onlyRequired
categorystring · nullableOptional
vendor_being_replacedstring · nullableOptional
replacement_urgencystring · nullableOptional
partner_typestringRead-onlyRequired
parent_companystring · nullableOptional
investorsstringRead-onlyRequired
partnersstringRead-onlyRequired
subsidiariesstringRead-onlyRequired
contacts_countstringRead-onlyRequired
is_draftbooleanOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
record_sourcestringRead-onlyRequired
associated_deal_projectstringRead-onlyRequired
get/api/company/{id}/
GET /api/company/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "text",
  "company_id": "text",
  "display_id": "text",
  "company_name": "text",
  "domain": "text",
  "linkedin_url": "text",
  "twitter_url": "text",
  "hq_location": "text",
  "hq_country": "text",
  "industry": "text",
  "employee_range": "text",
  "estimated_arr": "text",
  "description": "text",
  "logo_url": "text",
  "company_owner": "text",
  "company_type": "text",
  "lead_status": "text",
  "icp_fit": "text",
  "customer_segment": "text",
  "connection_strength": "text",
  "connection_source": "text",
  "operating_regions": "text",
  "category": "text",
  "vendor_being_replaced": "text",
  "replacement_urgency": "text",
  "partner_type": "text",
  "parent_company": "text",
  "investors": "text",
  "partners": "text",
  "subsidiaries": "text",
  "contacts_count": "text",
  "is_draft": true,
  "creation_time": "2026-01-01T00:00:00.000Z",
  "last_update_time": "2026-01-01T00:00:00.000Z",
  "record_source": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "associated_deal_project": "text"
}

Edits the company with the given id

put

This endpoint is used to edit a company 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/company/{id}/
PUT /api/company/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "company_id": "existing_company_id",
  "company_name": "Acme Corp Updated"
}
200

No response body

No content

Deletes the company with the given id

delete

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

No response body

No content

Get completed meetings for a company

get

Returns completed meetings (start <= now) for a company, paginated by start time descending.

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.

idstringRead-onlyRequired
company_idstringRequired
display_idstring · max: 100 · nullableOptional
company_namestring · max: 255Required
domainstring · nullableOptional
linkedin_urlstringRead-onlyRequired
twitter_urlstringRead-onlyRequired
hq_locationstringRead-onlyRequired
hq_countrystringRead-onlyRequired
industrystringRead-onlyRequired
employee_rangestring · nullableOptional
estimated_arrstringRead-onlyRequired
descriptionstring · nullableOptional
logo_urlstringRead-onlyRequired
company_ownerstringRead-onlyRequired
company_typestring · nullableOptional
lead_statusstringRead-onlyRequired
icp_fitstring · nullableOptional
customer_segmentstringRead-onlyRequired
connection_strengthstring · nullableOptional
connection_sourcestring · nullableOptional
operating_regionsstringRead-onlyRequired
categorystring · nullableOptional
vendor_being_replacedstring · nullableOptional
replacement_urgencystring · nullableOptional
partner_typestringRead-onlyRequired
parent_companystring · nullableOptional
investorsstringRead-onlyRequired
partnersstringRead-onlyRequired
subsidiariesstringRead-onlyRequired
contacts_countstringRead-onlyRequired
is_draftbooleanOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
record_sourcestringRead-onlyRequired
associated_deal_projectstringRead-onlyRequired
get/api/company/{id}/completed-meetings/
GET /api/company/{id}/completed-meetings/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "text",
  "company_id": "text",
  "display_id": "text",
  "company_name": "text",
  "domain": "text",
  "linkedin_url": "text",
  "twitter_url": "text",
  "hq_location": "text",
  "hq_country": "text",
  "industry": "text",
  "employee_range": "text",
  "estimated_arr": "text",
  "description": "text",
  "logo_url": "text",
  "company_owner": "text",
  "company_type": "text",
  "lead_status": "text",
  "icp_fit": "text",
  "customer_segment": "text",
  "connection_strength": "text",
  "connection_source": "text",
  "operating_regions": "text",
  "category": "text",
  "vendor_being_replaced": "text",
  "replacement_urgency": "text",
  "partner_type": "text",
  "parent_company": "text",
  "investors": "text",
  "partners": "text",
  "subsidiaries": "text",
  "contacts_count": "text",
  "is_draft": true,
  "creation_time": "2026-01-01T00:00:00.000Z",
  "last_update_time": "2026-01-01T00:00:00.000Z",
  "record_source": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "associated_deal_project": "text"
}

Get contacts for a company

get

This endpoint returns all contacts belonging to a given company

Authorizations
AuthorizationstringRequired

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

Path parameters
idstringRequired
Query parameters
items_per_pageintegerOptional

Items Per Page

pageintegerOptional

Page Number

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.

idstringRead-onlyRequired
company_idstringRequired
display_idstring · max: 100 · nullableOptional
company_namestring · max: 255Required
domainstring · nullableOptional
linkedin_urlstringRead-onlyRequired
twitter_urlstringRead-onlyRequired
hq_locationstringRead-onlyRequired
hq_countrystringRead-onlyRequired
industrystringRead-onlyRequired
employee_rangestring · nullableOptional
estimated_arrstringRead-onlyRequired
descriptionstring · nullableOptional
logo_urlstringRead-onlyRequired
company_ownerstringRead-onlyRequired
company_typestring · nullableOptional
lead_statusstringRead-onlyRequired
icp_fitstring · nullableOptional
customer_segmentstringRead-onlyRequired
connection_strengthstring · nullableOptional
connection_sourcestring · nullableOptional
operating_regionsstringRead-onlyRequired
categorystring · nullableOptional
vendor_being_replacedstring · nullableOptional
replacement_urgencystring · nullableOptional
partner_typestringRead-onlyRequired
parent_companystring · nullableOptional
investorsstringRead-onlyRequired
partnersstringRead-onlyRequired
subsidiariesstringRead-onlyRequired
contacts_countstringRead-onlyRequired
is_draftbooleanOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
record_sourcestringRead-onlyRequired
associated_deal_projectstringRead-onlyRequired
get/api/company/{id}/contacts/
GET /api/company/{id}/contacts/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "text",
  "company_id": "text",
  "display_id": "text",
  "company_name": "text",
  "domain": "text",
  "linkedin_url": "text",
  "twitter_url": "text",
  "hq_location": "text",
  "hq_country": "text",
  "industry": "text",
  "employee_range": "text",
  "estimated_arr": "text",
  "description": "text",
  "logo_url": "text",
  "company_owner": "text",
  "company_type": "text",
  "lead_status": "text",
  "icp_fit": "text",
  "customer_segment": "text",
  "connection_strength": "text",
  "connection_source": "text",
  "operating_regions": "text",
  "category": "text",
  "vendor_being_replaced": "text",
  "replacement_urgency": "text",
  "partner_type": "text",
  "parent_company": "text",
  "investors": "text",
  "partners": "text",
  "subsidiaries": "text",
  "contacts_count": "text",
  "is_draft": true,
  "creation_time": "2026-01-01T00:00:00.000Z",
  "last_update_time": "2026-01-01T00:00:00.000Z",
  "record_source": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "associated_deal_project": "text"
}

Get uninvited contacts for a company

get

Returns contacts of a company that are not yet linked to a customer user. Used for the Add Contact flow when inviting customers to a project.

Authorizations
AuthorizationstringRequired

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

Path parameters
idstringRequired
Query parameters
items_per_pageintegerOptional

Items Per Page

pageintegerOptional

Page Number

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.

idstringRead-onlyRequired
company_idstringRequired
display_idstring · max: 100 · nullableOptional
company_namestring · max: 255Required
domainstring · nullableOptional
linkedin_urlstringRead-onlyRequired
twitter_urlstringRead-onlyRequired
hq_locationstringRead-onlyRequired
hq_countrystringRead-onlyRequired
industrystringRead-onlyRequired
employee_rangestring · nullableOptional
estimated_arrstringRead-onlyRequired
descriptionstring · nullableOptional
logo_urlstringRead-onlyRequired
company_ownerstringRead-onlyRequired
company_typestring · nullableOptional
lead_statusstringRead-onlyRequired
icp_fitstring · nullableOptional
customer_segmentstringRead-onlyRequired
connection_strengthstring · nullableOptional
connection_sourcestring · nullableOptional
operating_regionsstringRead-onlyRequired
categorystring · nullableOptional
vendor_being_replacedstring · nullableOptional
replacement_urgencystring · nullableOptional
partner_typestringRead-onlyRequired
parent_companystring · nullableOptional
investorsstringRead-onlyRequired
partnersstringRead-onlyRequired
subsidiariesstringRead-onlyRequired
contacts_countstringRead-onlyRequired
is_draftbooleanOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
record_sourcestringRead-onlyRequired
associated_deal_projectstringRead-onlyRequired
get/api/company/{id}/contacts-for-invite/
GET /api/company/{id}/contacts-for-invite/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "text",
  "company_id": "text",
  "display_id": "text",
  "company_name": "text",
  "domain": "text",
  "linkedin_url": "text",
  "twitter_url": "text",
  "hq_location": "text",
  "hq_country": "text",
  "industry": "text",
  "employee_range": "text",
  "estimated_arr": "text",
  "description": "text",
  "logo_url": "text",
  "company_owner": "text",
  "company_type": "text",
  "lead_status": "text",
  "icp_fit": "text",
  "customer_segment": "text",
  "connection_strength": "text",
  "connection_source": "text",
  "operating_regions": "text",
  "category": "text",
  "vendor_being_replaced": "text",
  "replacement_urgency": "text",
  "partner_type": "text",
  "parent_company": "text",
  "investors": "text",
  "partners": "text",
  "subsidiaries": "text",
  "contacts_count": "text",
  "is_draft": true,
  "creation_time": "2026-01-01T00:00:00.000Z",
  "last_update_time": "2026-01-01T00:00:00.000Z",
  "record_source": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "associated_deal_project": "text"
}

Get deals for a company

get

This endpoint returns deals belonging to a given company.

Authorizations
AuthorizationstringRequired

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

Path parameters
idstringRequired
Query parameters
next_cursorstringOptional

Cursor for next page

page_sizeintegerOptional

Items Per Page

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.

idstringRead-onlyRequired
company_idstringRequired
display_idstring · max: 100 · nullableOptional
company_namestring · max: 255Required
domainstring · nullableOptional
linkedin_urlstringRead-onlyRequired
twitter_urlstringRead-onlyRequired
hq_locationstringRead-onlyRequired
hq_countrystringRead-onlyRequired
industrystringRead-onlyRequired
employee_rangestring · nullableOptional
estimated_arrstringRead-onlyRequired
descriptionstring · nullableOptional
logo_urlstringRead-onlyRequired
company_ownerstringRead-onlyRequired
company_typestring · nullableOptional
lead_statusstringRead-onlyRequired
icp_fitstring · nullableOptional
customer_segmentstringRead-onlyRequired
connection_strengthstring · nullableOptional
connection_sourcestring · nullableOptional
operating_regionsstringRead-onlyRequired
categorystring · nullableOptional
vendor_being_replacedstring · nullableOptional
replacement_urgencystring · nullableOptional
partner_typestringRead-onlyRequired
parent_companystring · nullableOptional
investorsstringRead-onlyRequired
partnersstringRead-onlyRequired
subsidiariesstringRead-onlyRequired
contacts_countstringRead-onlyRequired
is_draftbooleanOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
record_sourcestringRead-onlyRequired
associated_deal_projectstringRead-onlyRequired
get/api/company/{id}/deals/
GET /api/company/{id}/deals/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "text",
  "company_id": "text",
  "display_id": "text",
  "company_name": "text",
  "domain": "text",
  "linkedin_url": "text",
  "twitter_url": "text",
  "hq_location": "text",
  "hq_country": "text",
  "industry": "text",
  "employee_range": "text",
  "estimated_arr": "text",
  "description": "text",
  "logo_url": "text",
  "company_owner": "text",
  "company_type": "text",
  "lead_status": "text",
  "icp_fit": "text",
  "customer_segment": "text",
  "connection_strength": "text",
  "connection_source": "text",
  "operating_regions": "text",
  "category": "text",
  "vendor_being_replaced": "text",
  "replacement_urgency": "text",
  "partner_type": "text",
  "parent_company": "text",
  "investors": "text",
  "partners": "text",
  "subsidiaries": "text",
  "contacts_count": "text",
  "is_draft": true,
  "creation_time": "2026-01-01T00:00:00.000Z",
  "last_update_time": "2026-01-01T00:00:00.000Z",
  "record_source": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "associated_deal_project": "text"
}

Get projects for a company

get

This endpoint returns projects belonging to a given company.

Authorizations
AuthorizationstringRequired

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

Path parameters
idstringRequired
Query parameters
next_cursorstringOptional

Cursor for next page

page_sizeintegerOptional

Items Per Page

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.

idstringRead-onlyRequired
company_idstringRequired
display_idstring · max: 100 · nullableOptional
company_namestring · max: 255Required
domainstring · nullableOptional
linkedin_urlstringRead-onlyRequired
twitter_urlstringRead-onlyRequired
hq_locationstringRead-onlyRequired
hq_countrystringRead-onlyRequired
industrystringRead-onlyRequired
employee_rangestring · nullableOptional
estimated_arrstringRead-onlyRequired
descriptionstring · nullableOptional
logo_urlstringRead-onlyRequired
company_ownerstringRead-onlyRequired
company_typestring · nullableOptional
lead_statusstringRead-onlyRequired
icp_fitstring · nullableOptional
customer_segmentstringRead-onlyRequired
connection_strengthstring · nullableOptional
connection_sourcestring · nullableOptional
operating_regionsstringRead-onlyRequired
categorystring · nullableOptional
vendor_being_replacedstring · nullableOptional
replacement_urgencystring · nullableOptional
partner_typestringRead-onlyRequired
parent_companystring · nullableOptional
investorsstringRead-onlyRequired
partnersstringRead-onlyRequired
subsidiariesstringRead-onlyRequired
contacts_countstringRead-onlyRequired
is_draftbooleanOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
record_sourcestringRead-onlyRequired
associated_deal_projectstringRead-onlyRequired
get/api/company/{id}/projects/
GET /api/company/{id}/projects/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "text",
  "company_id": "text",
  "display_id": "text",
  "company_name": "text",
  "domain": "text",
  "linkedin_url": "text",
  "twitter_url": "text",
  "hq_location": "text",
  "hq_country": "text",
  "industry": "text",
  "employee_range": "text",
  "estimated_arr": "text",
  "description": "text",
  "logo_url": "text",
  "company_owner": "text",
  "company_type": "text",
  "lead_status": "text",
  "icp_fit": "text",
  "customer_segment": "text",
  "connection_strength": "text",
  "connection_source": "text",
  "operating_regions": "text",
  "category": "text",
  "vendor_being_replaced": "text",
  "replacement_urgency": "text",
  "partner_type": "text",
  "parent_company": "text",
  "investors": "text",
  "partners": "text",
  "subsidiaries": "text",
  "contacts_count": "text",
  "is_draft": true,
  "creation_time": "2026-01-01T00:00:00.000Z",
  "last_update_time": "2026-01-01T00:00:00.000Z",
  "record_source": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "associated_deal_project": "text"
}

Get tasks for a company

get

This endpoint returns tasks belonging to the account linked to a given company.

Authorizations
AuthorizationstringRequired

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

Path parameters
idstringRequired
Query parameters
next_cursorstringOptional

Cursor for next page

page_sizeintegerOptional

Items Per Page

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.

idstringRead-onlyRequired
company_idstringRequired
display_idstring · max: 100 · nullableOptional
company_namestring · max: 255Required
domainstring · nullableOptional
linkedin_urlstringRead-onlyRequired
twitter_urlstringRead-onlyRequired
hq_locationstringRead-onlyRequired
hq_countrystringRead-onlyRequired
industrystringRead-onlyRequired
employee_rangestring · nullableOptional
estimated_arrstringRead-onlyRequired
descriptionstring · nullableOptional
logo_urlstringRead-onlyRequired
company_ownerstringRead-onlyRequired
company_typestring · nullableOptional
lead_statusstringRead-onlyRequired
icp_fitstring · nullableOptional
customer_segmentstringRead-onlyRequired
connection_strengthstring · nullableOptional
connection_sourcestring · nullableOptional
operating_regionsstringRead-onlyRequired
categorystring · nullableOptional
vendor_being_replacedstring · nullableOptional
replacement_urgencystring · nullableOptional
partner_typestringRead-onlyRequired
parent_companystring · nullableOptional
investorsstringRead-onlyRequired
partnersstringRead-onlyRequired
subsidiariesstringRead-onlyRequired
contacts_countstringRead-onlyRequired
is_draftbooleanOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
record_sourcestringRead-onlyRequired
associated_deal_projectstringRead-onlyRequired
get/api/company/{id}/tasks/
GET /api/company/{id}/tasks/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "text",
  "company_id": "text",
  "display_id": "text",
  "company_name": "text",
  "domain": "text",
  "linkedin_url": "text",
  "twitter_url": "text",
  "hq_location": "text",
  "hq_country": "text",
  "industry": "text",
  "employee_range": "text",
  "estimated_arr": "text",
  "description": "text",
  "logo_url": "text",
  "company_owner": "text",
  "company_type": "text",
  "lead_status": "text",
  "icp_fit": "text",
  "customer_segment": "text",
  "connection_strength": "text",
  "connection_source": "text",
  "operating_regions": "text",
  "category": "text",
  "vendor_being_replaced": "text",
  "replacement_urgency": "text",
  "partner_type": "text",
  "parent_company": "text",
  "investors": "text",
  "partners": "text",
  "subsidiaries": "text",
  "contacts_count": "text",
  "is_draft": true,
  "creation_time": "2026-01-01T00:00:00.000Z",
  "last_update_time": "2026-01-01T00:00:00.000Z",
  "record_source": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "associated_deal_project": "text"
}

Get upcoming meetings for a company

get

Returns upcoming meetings (start > now) for a company, paginated by start time ascending.

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.

idstringRead-onlyRequired
company_idstringRequired
display_idstring · max: 100 · nullableOptional
company_namestring · max: 255Required
domainstring · nullableOptional
linkedin_urlstringRead-onlyRequired
twitter_urlstringRead-onlyRequired
hq_locationstringRead-onlyRequired
hq_countrystringRead-onlyRequired
industrystringRead-onlyRequired
employee_rangestring · nullableOptional
estimated_arrstringRead-onlyRequired
descriptionstring · nullableOptional
logo_urlstringRead-onlyRequired
company_ownerstringRead-onlyRequired
company_typestring · nullableOptional
lead_statusstringRead-onlyRequired
icp_fitstring · nullableOptional
customer_segmentstringRead-onlyRequired
connection_strengthstring · nullableOptional
connection_sourcestring · nullableOptional
operating_regionsstringRead-onlyRequired
categorystring · nullableOptional
vendor_being_replacedstring · nullableOptional
replacement_urgencystring · nullableOptional
partner_typestringRead-onlyRequired
parent_companystring · nullableOptional
investorsstringRead-onlyRequired
partnersstringRead-onlyRequired
subsidiariesstringRead-onlyRequired
contacts_countstringRead-onlyRequired
is_draftbooleanOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
record_sourcestringRead-onlyRequired
associated_deal_projectstringRead-onlyRequired
get/api/company/{id}/upcoming-meetings/
GET /api/company/{id}/upcoming-meetings/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "text",
  "company_id": "text",
  "display_id": "text",
  "company_name": "text",
  "domain": "text",
  "linkedin_url": "text",
  "twitter_url": "text",
  "hq_location": "text",
  "hq_country": "text",
  "industry": "text",
  "employee_range": "text",
  "estimated_arr": "text",
  "description": "text",
  "logo_url": "text",
  "company_owner": "text",
  "company_type": "text",
  "lead_status": "text",
  "icp_fit": "text",
  "customer_segment": "text",
  "connection_strength": "text",
  "connection_source": "text",
  "operating_regions": "text",
  "category": "text",
  "vendor_being_replaced": "text",
  "replacement_urgency": "text",
  "partner_type": "text",
  "parent_company": "text",
  "investors": "text",
  "partners": "text",
  "subsidiaries": "text",
  "contacts_count": "text",
  "is_draft": true,
  "creation_time": "2026-01-01T00:00:00.000Z",
  "last_update_time": "2026-01-01T00:00:00.000Z",
  "record_source": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "associated_deal_project": "text"
}

Company Activities for a company

get

Returns all activities for the company id given

Authorizations
AuthorizationstringRequired

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

Responses
200

No response body

No content

get/api/company/activities/
GET /api/company/activities/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Bulk delete companies

post

Bulk delete companies by their IDs

Authorizations
AuthorizationstringRequired

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

Body
Other propertiesanyOptional
Responses
200

No response body

No content

post/api/company/bulk-delete/
POST /api/company/bulk-delete/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
200

No response body

No content

Bulk publish companies

post

Publish multiple companies by setting is_draft=False

Authorizations
AuthorizationstringRequired

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

Body
Other propertiesanyOptional
Responses
200

No response body

No content

post/api/company/bulk-publish/
POST /api/company/bulk-publish/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
200

No response body

No content

Updates a company category name

post

This endpoint is used to update the name of a company category

Authorizations
AuthorizationstringRequired

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

Body
Other propertiesanyOptional
Responses
200

No response body

No content

post/api/company/category/
POST /api/company/category/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "value": "crm",
  "name": "Updated Category Name"
}
200

No response body

No content

Deletes a company category

post

This endpoint is used to delete a company category

Authorizations
AuthorizationstringRequired

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

Body
Other propertiesanyOptional
Responses
200

No response body

No content

post/api/company/del_category/
POST /api/company/del_category/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "value": "crm"
}
200

No response body

No content

Company field config

get

Get or save custom field definitions for companies

Authorizations
AuthorizationstringRequired

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

Responses
200

No response body

No content

get/api/company/field-config/
GET /api/company/field-config/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Company field config

put

Get or save custom field definitions for companies

Authorizations
AuthorizationstringRequired

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

Body
Other propertiesanyOptional
Responses
200

No response body

No content

put/api/company/field-config/
PUT /api/company/field-config/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
200

No response body

No content

Bulk import companies

post

This endpoint is used to bulk import companies from a CSV-parsed array

Authorizations
AuthorizationstringRequired

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

Body
Other propertiesanyOptional
Responses
200

No response body

No content

post/api/company/import/
POST /api/company/import/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
200

No response body

No content

Company form options

get

Returns all dropdown options for the company form including org verticals

Authorizations
AuthorizationstringRequired

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

Responses
200

No response body

No content

get/api/company/options/
GET /api/company/options/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Last updated