CRM
Généralités
Les entités et endpoints décrits ci-dessous ne sont pas une liste exhaustive. Ils ne représentent que les plus couramment utilisés.
Veuillez vous référer au chapitre USAGE pour en savoir plus.
Remarque
Les paramètres énumérés pour les requêtes "POST" sont uniquement des exemples de paramètres obligatoires. Ils varient selon le sous-domaine utilisé.
L'ensemble des paramètres sont disponibles dans la section "Attributes" de chaque entité
Chemin
Pour accéder à votre API depuis un compte en production vous devez utiliser le chemin suivant :
https://<account_subdomain>.nicoka.com/api/
https://trial.nicoka.com/<account_subdomain>/api/
Note
<account_subdomain> désigne le nom de votre sous-domaine Nicoka
Connexion à l'API
Voir le chapitre Connexion à l'API
Valeurs des listes déroulantes
Dans cette page, vous trouverez les principales entités et endpoints nécesssaires.
La valeur de certains attributs sont disponibles dans Nicoka sous forme de liste. Cette liste est :
- soit disponible depuis le endpoint référencé directement sous l'attribut
- soit reliée à une entité décrite dans cette documentation API
Exemple 1 : Endpoint référencé directement sous l'attribut
source int (Liste déroulante : Provenance)
Provenance de la candidature
Endpoint de récupération des valeurs: /application/entities/462/values/
La liste des valeurs possibles pour source est disponible à cet url:
https://<account_subdomain>.nicoka.com/api/application/entities/462/values/pour un compte en productionhttps://trial.nicoka.com/<account_subdomain>/api/application/entities/462/values/pour compte d'essai
Exemple 2 : Endpoint relié à une entité décrite dans cette documentation
candidateid int (Liste déroulante : Candidat)
Candidat
cliquer sur le lien Liste déroulante : Candidat à côté de l'attribut. Vous serez redirigé vers l'entité correspondante,ici l'entité Candidat.
Vous pourrez alors obtenir la Liste des candidats avec le endpoint correspondant GET /candidates.
Compte
Overview
Attributes
customerid int
ID Système
owner_objectid int (Liste déroulante : Collaborateur)
Assigné à
name1 string
Nom
name2 string
Raison Sociale
picture string
Logo
reference string
Code
external_reference string
Réf. Externe
parentid int (Liste déroulante : Compte)
Compte Parent
type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/201/values/
status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/202/values/
email string (CHAR255)
Email
sourceid int (Liste déroulante : Provenance)
Provenance
Endpoint de récupération des valeurs: /application/entities/262/values/
status_udate datetime
Statut (MàJ le)
communication_language int (Liste déroulante : Langue)
Langue de communication
Endpoint de récupération des valeurs: /application/entities/14/values/
compid int (Liste déroulante : Société)
Société
legal_form string
Forme juridique
year_of_creation int
Année de création
capital string
Capital
locationid int (Liste déroulante : Agence)
Agence
trade_reg_number string
RCS
wfid int (Liste déroulante : Effectif)
Effectif
Endpoint de récupération des valeurs: /application/entities/1312/values/
trade_reg_location string
RC Lieux
vat_reg_number string
Numéro de TVA
identification_number string
SIRET
account_number string
N° compte
credit_limit double
Limite Crédit
payment_mode int (Liste déroulante : Mode de paiement)
Mode de paiement
Endpoint de récupération des valeurs: /application/entities/1566/values/
payment_conditionid int (Liste déroulante : Condition de paiement)
Condition de paiement
Endpoint de récupération des valeurs: /application/entities/1565/values/
profit_accountid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/
vatid int (Liste déroulante : Taux de TVA)
Taux de TVA
Endpoint de récupération des valeurs: /application/entities/1608/values/
payment_notes string (TEXT)
Info. de paiement
fiscal_scale int (Liste déroulante : Barême Fiscal)
Barême Fiscal
Endpoint de récupération des valeurs: /application/entities/181/values/
industry int (Liste déroulante : Secteur d'activité)
Secteur d'activité
Endpoint de récupération des valeurs: /application/entities/143/values/
website string (CHAR255)
Site Web
credit_debit_authorized_on date
Autorisation Prélèvement signé le
areaid string
Localisation Géo.
phone string (CHAR35)
Tél. Standard
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
vat_rates string
Taux de TVA
divisions longtext (multiple)
Zones d'intervention
Endpoint de récupération des valeurs: /application/entities/104/values/
main_contactid int (Liste déroulante : Contact)
Contact Principal
commercial_contactid int (Liste déroulante : Contact)
Contact Commercial
nb_of_open_tasks int
Nb. de tâches en cours
support_contactid int (Liste déroulante : Contact)
Contact Support
tags longtext (multiple)
Tags
Endpoint de récupération des valeurs: /application/entities/216/values/
nb_of_tasks int
Nb. de tâches
invoicing_contactid int (Liste déroulante : Contact)
Contact Facturation
zipcode string
Code Postal
city string
Ville
assignment_type int
Visible par
country int (Liste déroulante : Pays)
Pays
Endpoint de récupération des valeurs: /application/entities/13/values/
first_invoice_date date
Date de première facture
area_lvl5 string
Région
cancellation_date date
Date de résiliation
last_invoice_date date
Date de la dernière facture
cancellation_reason string (TEXT)
Résiliation commentaires
invoicing_modeid int (Liste déroulante : Modalité de facturation)
Modalité de facturation
Endpoint de récupération des valeurs: /application/entities/219/values/
cancellation_reasonid int (Liste déroulante : Motif de résiliation)
Motif de résiliation
Endpoint de récupération des valeurs: /application/entities/218/values/
cdate datetime
Créé le
cname int (Liste déroulante : Utilisateur)
Créé par
owner_entityid int (Liste déroulante : Entité)
Propriétaire (Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/
udate datetime
MàJ le
industries longtext (multiple)
Secteurs d'activité
Endpoint de récupération des valeurs: /application/entities/143/values/
address_state string
Région (Libellé)
business_activity_code string
Code NAF
uname int (Liste déroulante : Utilisateur)
MàJ par
county string
Département
bulkid int (Liste déroulante : Log import)
Log import
Endpoint de récupération des valeurs: /application/entities/41/values/
fax string (CHAR35)
Fax
social_networks string
Réseaux Sociaux
bank_name string
Nom de la banque
bank_account_owner string
Titulaire du compte
swift string
Code BIC/Swift
iban string
IBAN
last_noteid longtext
Dernière note
last_meeting_minuteid string (TEXT)
Dernier compte rendu
last_activityid int (Liste déroulante : Activité)
Dernière action
last_action_on datetime
Dernière action le
last_email_sent_on datetime
Dernier e-mail envoyé le
bank_account_number string
N° de compte bancaire
last_email_received_on datetime
Dernier e-mail reçu le
last_phone_call_on datetime
Dernier appel le
last_phone_successful_call_on datetime
Dernier appel réussi le
last_meeting_on datetime
Dernier meeting le
nb_of_contacts int
Nb. de contacts
taskid int (Liste déroulante : Tâche)
Dernière Tâche
Endpoint de récupération des valeurs: /application/entities/60/values/
nb_of_jobs int
Nb. de missions
last_note_on datetime
Dernière note le
nb_of_open_jobs int
Nb. de missions en cours
last_meeting_minute_on datetime
Dernier compte rendu le
last_action_by_userid int (Liste déroulante : Utilisateur)
Dernière action effectué par
nb_of_opportunities int
Nb. d'opportunités
comments longtext
Description
nb_of_open_opportunities int
Nb. d'opportunités ouvertes
inline_partners string
Responsables
Liste des comptes
REQUEST
GET /customers
RESPONSE
200 OK
{
"queryUid": "7c8c41c94e3c1f170292e829c7c2ffe1",
"offset": 0,
"limit": 5,
"page": 1,
"pages": 1,
"total": 5,
"data": [
{
"id": 2677,
"label": "Entreprise Machin",
"customerid": 2677,
"type": 1,
"parentid": null,
"companyid": null,
"title": null,
"status": 2,
"status_udate": "2024-10-25 10:09:19",
"compid": 1,
"locationid": 1,
"divisions": null,
"sourceid": null,
"main_contactid": 5269,
"commercial_contactid": null,
"support_contactid": null,
"ordering_contactid": null,
"invoicing_contactid": null,
"dunning_contactid": null,
"reference": "",
"external_reference": null,
"campaignid": null,
"active": 1,
"keyname": "entreprise-machin",
"name1": "Entreprise Machin",
"name2": "",
"name3": null,
"name4": null,
"social_networks": null,
"email": null,
"phone": "+33 1 02 03 04 05",
"fax": null,
"communication_language": "fr",
"zipcode": "49100",
"city": "Angers",
"address_state": "Pays de la Loire",
"address_stateid": 759,
"county": "49 - Maine-et-Loire",
"countyid": 897,
"country": "FR",
"lat": "47.47278000",
"lng": "-0.55556000",
"areaid": 2289,
"area_level": 8,
"area_lvl1": 4,
"area_lvl2": 21,
"area_lvl3": 681,
"area_lvl4": 744,
"area_lvl5": 759,
"area_lvl6": 897,
"area_lvl7": 2233,
"industry": 120,
"industries": null,
"nb_of_employees": null,
"wfid": null,
"website": "www.entreprisemachin.fr",
"picture": "67bdc82ef1102.png",
"assignment_type": 1,
"assignment_targets": null,
"owner_entityid": 101,
"owner_objectid": 43,
"timezone": null,
"working_hours": null,
"day_duration_in_hours": null,
"holidays_country": null,
"year_of_creation": null,
"legal_form": null,
"capital": null,
"identification_number": "1251619656",
"trade_reg_number": null,
"trade_reg_location": null,
"vat_reg_number": null,
"account_number": "41123365",
"invoicing_modeid": null,
"payment_mode": 4,
"credit_debit_authorized_on": null,
"credit_debit_authorization_docid": null,
"payment_excluded_modes": null,
"payment_conditionid": 2,
"credit_limit": null,
"vatid": 1,
"vat_rates": "{\"1\":\"1\"}",
"profit_accounts": "{\"1\":null}",
"profit_accountid": null,
"currency": "EUR",
"bank_account_owner": null,
"bank_name": null,
"swift": null,
"iban": null,
"first_contact_on": null,
"last_contact_date": null,
"last_activityid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"last_meeting_minute_on": null,
"last_meeting_minuteid": null,
"last_noteid": null,
"last_callid": null,
"last_note_on": null,
"last_action_on": null,
"last_action_by_userid": null,
"taskid": null,
"first_invoice_date": "2024-11-04",
"last_invoice_date": null,
"cancellation_requested_on": null,
"cancellation_date": null,
"cancellation_reasonid": null,
"cancellation_reason": null,
"fiscal_scale": null,
"payment_notes": null,
"tags": null,
"comments": null,
"nb_of_partners": null,
"nb_of_sites": null,
"nb_of_contacts": 3,
"nb_of_open_jobs": null,
"nb_of_jobs": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"nb_of_open_opportunities": null,
"nb_of_opportunities": null,
"nb_of_invoices": null,
"indexing_status": 0,
"merging_log": null,
"inline_partners": null,
"bulkid": null,
"loekz": 0,
"cdate": "2024-10-25 10:09:19",
"cname": 46,
"udate": "2025-02-25 14:39:58",
"uname": 46,
"versi": 66
},
{
"id": 1,
"label": "Global Shape",
"customerid": 1,
"type": 1,
"parentid": null,
"companyid": null,
"title": 0,
"status": 2,
"status_udate": null,
"compid": 1,
"locationid": null,
"divisions": null,
"sourceid": null,
"main_contactid": 5272,
"commercial_contactid": null,
"support_contactid": null,
"ordering_contactid": null,
"invoicing_contactid": null,
"dunning_contactid": null,
"reference": "",
"external_reference": null,
"campaignid": null,
"active": 1,
"keyname": "global-shape",
"name1": "Global Shape",
"name2": "",
"name3": null,
"name4": null,
"social_networks": null,
"email": null,
"phone": null,
"fax": null,
"communication_language": "fr",
"zipcode": "49100",
"city": "Angers",
"address_state": "Pays de la Loire",
"address_stateid": 759,
"county": "49 - Maine-et-Loire",
"countyid": 897,
"country": "FR",
"lat": "47.48087060",
"lng": "-0.56791940",
"areaid": 2289,
"area_level": 8,
"area_lvl1": 4,
"area_lvl2": 21,
"area_lvl3": 681,
"area_lvl4": 744,
"area_lvl5": 759,
"area_lvl6": 897,
"area_lvl7": 2233,
"industry": null,
"industries": null,
"nb_of_employees": null,
"wfid": null,
"website": "",
"picture": null,
"assignment_type": 1,
"assignment_targets": null,
"owner_entityid": null,
"owner_objectid": null,
"timezone": null,
"working_hours": null,
"day_duration_in_hours": null,
"holidays_country": null,
"year_of_creation": null,
"legal_form": null,
"capital": null,
"identification_number": "",
"trade_reg_number": null,
"trade_reg_location": null,
"vat_reg_number": null,
"account_number": null,
"invoicing_modeid": null,
"payment_mode": 0,
"credit_debit_authorized_on": null,
"credit_debit_authorization_docid": null,
"payment_excluded_modes": "\"\"",
"payment_conditionid": 0,
"credit_limit": null,
"vatid": null,
"vat_rates": null,
"profit_accounts": null,
"profit_accountid": null,
"currency": null,
"bank_account_owner": null,
"bank_name": null,
"swift": null,
"iban": null,
"first_contact_on": null,
"last_contact_date": null,
"last_activityid": 1471424,
"last_email_sent_on": "2025-08-07 11:02:00",
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"last_meeting_minute_on": "2025-01-23 16:22:00",
"last_meeting_minuteid": 1471414,
"last_noteid": 1471413,
"last_callid": null,
"last_note_on": "2025-01-23 16:20:18",
"last_action_on": "2025-08-07 00:00:00",
"last_action_by_userid": 46,
"taskid": null,
"first_invoice_date": null,
"last_invoice_date": null,
"cancellation_requested_on": null,
"cancellation_date": null,
"cancellation_reasonid": null,
"cancellation_reason": null,
"fiscal_scale": null,
"payment_notes": null,
"tags": null,
"comments": null,
"nb_of_partners": null,
"nb_of_sites": null,
"nb_of_contacts": 1,
"nb_of_open_jobs": 0,
"nb_of_jobs": 0,
"nb_of_open_tasks": 0,
"nb_of_tasks": 0,
"nb_of_open_opportunities": 0,
"nb_of_opportunities": 0,
"nb_of_invoices": null,
"indexing_status": null,
"merging_log": null,
"inline_partners": null,
"bulkid": null,
"loekz": 0,
"cdate": "2014-10-22 16:00:07",
"cname": 6,
"udate": "2025-08-07 11:01:59",
"uname": 46,
"versi": 10
}
]
}
Créer un nouveau compte
REQUEST
POST /customers
{
"name1": "Noé IT"
}
RESPONSE
200 OK
{
"success": "Compte <b>Noé IT</b> a été ajouté",
"object": {
"id": "2679",
"label": "Noé IT",
"customerid": "2679",
"type": 1,
"parentid": null,
"companyid": null,
"title": null,
"status": 1,
"status_udate": "2025-09-15 13:37:44",
"compid": null,
"locationid": null,
"divisions": null,
"sourceid": null,
"main_contactid": null,
"commercial_contactid": null,
"support_contactid": null,
"ordering_contactid": null,
"invoicing_contactid": null,
"dunning_contactid": null,
"reference": null,
"external_reference": null,
"campaignid": null,
"active": true,
"keyname": "noe-it",
"name1": "Noé IT",
"name2": null,
"name3": null,
"name4": null,
"social_networks": null,
"email": null,
"phone": null,
"fax": null,
"communication_language": "fr",
"zipcode": null,
"city": null,
"address_state": null,
"address_stateid": null,
"county": null,
"countyid": null,
"country": null,
"lat": null,
"lng": null,
"areaid": null,
"area_level": null,
"area_lvl1": null,
"area_lvl2": null,
"area_lvl3": null,
"area_lvl4": null,
"area_lvl5": null,
"area_lvl6": null,
"area_lvl7": null,
"industry": null,
"industries": null,
"nb_of_employees": null,
"wfid": null,
"website": null,
"picture": null,
"assignment_type": "1",
"assignment_targets": null,
"owner_entityid": null,
"owner_objectid": null,
"timezone": null,
"working_hours": null,
"day_duration_in_hours": null,
"holidays_country": null,
"year_of_creation": null,
"legal_form": null,
"capital": null,
"identification_number": null,
"trade_reg_number": null,
"trade_reg_location": null,
"vat_reg_number": null,
"account_number": null,
"invoicing_modeid": null,
"payment_mode": 4,
"credit_debit_authorized_on": null,
"credit_debit_authorization_docid": null,
"payment_excluded_modes": null,
"payment_conditionid": 2,
"credit_limit": null,
"vatid": 1,
"vat_rates": null,
"profit_accounts": null,
"profit_accountid": null,
"currency": "EUR",
"bank_account_owner": null,
"bank_name": null,
"swift": null,
"iban": null,
"first_contact_on": null,
"last_contact_date": null,
"last_activityid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"last_meeting_minute_on": null,
"last_meeting_minuteid": null,
"last_noteid": null,
"last_callid": null,
"last_note_on": null,
"last_action_on": null,
"last_action_by_userid": null,
"taskid": null,
"first_invoice_date": null,
"last_invoice_date": null,
"cancellation_requested_on": null,
"cancellation_date": null,
"cancellation_reasonid": null,
"cancellation_reason": null,
"fiscal_scale": null,
"payment_notes": null,
"tags": null,
"comments": null,
"nb_of_partners": null,
"nb_of_sites": null,
"nb_of_contacts": 0,
"nb_of_open_jobs": null,
"nb_of_jobs": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"nb_of_open_opportunities": null,
"nb_of_opportunities": null,
"nb_of_invoices": null,
"indexing_status": 0,
"merging_log": null,
"inline_partners": null,
"bulkid": null,
"loekz": 0,
"cdate": "2025-09-15 13:37:44",
"cname": 54,
"udate": "2025-09-15 13:37:44",
"uname": 54,
"versi": 1,
"updateLink": "?route=customers/main&customerid=2679"
}
}
Récupérer un compte
Path params
Customerid (int)
Identifiant d'un compte
REQUEST
GET /customers/{customerid}
RESPONSE
200 OK
{
"id": 2677,
"label": "Entreprise Machin",
"customerid": 2677,
"type": 1,
"parentid": null,
"companyid": null,
"title": null,
"status": 2,
"status_udate": "2024-10-25 10:09:19",
"compid": 1,
"locationid": 1,
"divisions": null,
"sourceid": null,
"main_contactid": 5269,
"commercial_contactid": null,
"support_contactid": null,
"ordering_contactid": null,
"invoicing_contactid": null,
"dunning_contactid": null,
"reference": "",
"external_reference": null,
"campaignid": null,
"active": 1,
"keyname": "entreprise-machin",
"name1": "Entreprise Machin",
"name2": "",
"name3": null,
"name4": null,
"social_networks": null,
"email": null,
"phone": "+33 1 02 03 04 05",
"fax": null,
"communication_language": "fr",
"zipcode": "49100",
"city": "Angers",
"address_state": "Pays de la Loire",
"address_stateid": 759,
"county": "49 - Maine-et-Loire",
"countyid": 897,
"country": "FR",
"lat": "47.47278000",
"lng": "-0.55556000",
"areaid": 2289,
"area_level": 8,
"area_lvl1": 4,
"area_lvl2": 21,
"area_lvl3": 681,
"area_lvl4": 744,
"area_lvl5": 759,
"area_lvl6": 897,
"area_lvl7": 2233,
"industry": 120,
"industries": null,
"nb_of_employees": null,
"wfid": null,
"website": "www.entreprisemachin.fr",
"picture": "67bdc82ef1102.png",
"assignment_type": 1,
"assignment_targets": null,
"owner_entityid": 101,
"owner_objectid": 43,
"timezone": null,
"working_hours": null,
"day_duration_in_hours": null,
"holidays_country": null,
"year_of_creation": null,
"legal_form": null,
"capital": null,
"identification_number": "1251619656",
"trade_reg_number": null,
"trade_reg_location": null,
"vat_reg_number": null,
"account_number": "41123365",
"invoicing_modeid": null,
"payment_mode": 4,
"credit_debit_authorized_on": null,
"credit_debit_authorization_docid": null,
"payment_excluded_modes": null,
"payment_conditionid": 2,
"credit_limit": null,
"vatid": 1,
"vat_rates": "{\"1\":\"1\"}",
"profit_accounts": "{\"1\":null}",
"profit_accountid": null,
"currency": "EUR",
"bank_account_owner": null,
"bank_name": null,
"swift": null,
"iban": null,
"first_contact_on": null,
"last_contact_date": null,
"last_activityid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"last_meeting_minute_on": null,
"last_meeting_minuteid": null,
"last_noteid": null,
"last_callid": null,
"last_note_on": null,
"last_action_on": null,
"last_action_by_userid": null,
"taskid": null,
"first_invoice_date": "2024-11-04",
"last_invoice_date": null,
"cancellation_requested_on": null,
"cancellation_date": null,
"cancellation_reasonid": null,
"cancellation_reason": null,
"fiscal_scale": null,
"payment_notes": null,
"tags": null,
"comments": null,
"nb_of_partners": null,
"nb_of_sites": null,
"nb_of_contacts": 3,
"nb_of_open_jobs": null,
"nb_of_jobs": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"nb_of_open_opportunities": null,
"nb_of_opportunities": null,
"nb_of_invoices": null,
"indexing_status": 0,
"merging_log": null,
"inline_partners": null,
"bulkid": null,
"loekz": 0,
"cdate": "2024-10-25 10:09:19",
"cname": 46,
"udate": "2025-02-25 14:39:58",
"uname": 46,
"versi": 66,
"updateLink": "?route=customers/main&customerid=2677"
}
Contact
Overview
Attributes
contactid int
ID Système
picture string
Photo
type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/251/values/
reference string
Référence
civility int
Civilité
customerid int (Liste déroulante : Compte)
Compte
supplierid int (Liste déroulante : Fournisseur)
Fournisseur
last_name string
Nom
first_name string
Prénom
middle_name string
Autre prénom
assignment_type int
Visible par
birth_name string
Nom de naissance
email string (CHAR255)
Email
headline string
Fonction
email2 string (CHAR255)
Autre email
phone1 string (CHAR35)
Téléphone 1
jobtitle int (Liste déroulante : Intitulé du poste)
Intitulé du poste
Endpoint de récupération des valeurs: /application/entities/141/values/
phone1_ext string
Ext. (Tél. 1)
phone2 string (CHAR35)
Téléphone 2
status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/252/values/
taskid int (Liste déroulante : Tâche)
Dernière Tâche
Endpoint de récupération des valeurs: /application/entities/60/values/
birth_date date
Date de naissance
phone2_ext string
Ext. (Tél. 2)
phone3 string (CHAR35)
Téléphone 3
source int (Liste déroulante : Provenance)
Provenance
Endpoint de récupération des valeurs: /application/entities/262/values/
phone4 string (CHAR35)
Téléphone 4
communication_language int (Liste déroulante : Langue Parlée)
Langue de communication
Endpoint de récupération des valeurs: /application/entities/112/values/
siteid int (Liste déroulante : Site)
Site
Endpoint de récupération des valeurs: /application/entities/214/values/
analytic_account string
Compte analytique
owner_employeeid int (Liste déroulante : Collaborateur)
Assigné à
tags longtext (multiple)
Tags
Endpoint de récupération des valeurs: /application/entities/267/values/
proid int (Liste déroulante : Profil)
Profil
Endpoint de récupération des valeurs: /application/entities/5/values/
areaid string
Localisation Géo.
last_activityid int (Liste déroulante : Activité)
Dernière action
cdate datetime
Créé le
zipcode string
Code Postal
owner_entityid string
Propriétaire (Entité)
city string
Ville
cname int (Liste déroulante : Utilisateur)
Créé par
owner_id string
Propriétaire (Id)
has_access boolean
A accès
udate datetime
MàJ le
country int (Liste déroulante : Pays)
Pays
Endpoint de récupération des valeurs: /application/entities/13/values/
nb_of_open_tasks int
Nb. de tâches en cours
uname int (Liste déroulante : Utilisateur)
MàJ par
street string
Adresse
nb_of_tasks int
Nb. de tâches
locationid int (Liste déroulante : Agence)
Agence
area_lvl5 string
Région
roomid int (Liste déroulante : Bureau/Salle)
Bureau/Salle
Endpoint de récupération des valeurs: /application/entities/93/values/
divisionid int (Liste déroulante : Zone d'intervention)
Zone d'intervention
Endpoint de récupération des valeurs: /application/entities/104/values/
industryid int (Liste déroulante : Secteur d'activité)
Secteur d'activité
Endpoint de récupération des valeurs: /application/entities/143/values/
external_reference string
Réf. Externe
department string
Service/Division
departmentid int (Liste déroulante : Service)
Service
Endpoint de récupération des valeurs: /application/entities/103/values/
nb_of_open_opportunities int
Nb. d'opportunités ouvertes
nb_of_opportunities int
Nb. d'opportunités
has_opted_out_of_email boolean
Ne souhaite pas recevoir d'email marketing
nb_of_open_jobs int
Nb. de missions en cours
nb_of_jobs int
Nb. de missions
divisions longtext (multiple)
Zones d'intervention
Endpoint de récupération des valeurs: /application/entities/104/values/
average_daily_rate double
TJM
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
desired_positions longtext (multiple)
Postes recherchés
Endpoint de récupération des valeurs: /application/entities/141/values/
has_opted_out_of_sms boolean
Ne souhaite pas recevoir de SMS
last_email_sent_on datetime
Dernier e-mail envoyé le
last_phone_call_on datetime
Dernier appel le
last_meeting_on datetime
Dernier meeting le
last_action_on datetime
Dernière action le
description longtext
Description
last_note_on datetime
Dernière note le
last_noteid longtext
Dernière note
last_meeting_minuteid string (TEXT)
Dernier compte rendu
last_meeting_minute_on datetime
Dernier compte rendu le
last_email_received_on datetime
Dernier e-mail reçu le
last_phone_successful_call_on datetime
Dernier appel réussi le
bulkid int (Liste déroulante : Log import)
Log import
Endpoint de récupération des valeurs: /application/entities/41/values/
last_action_by_userid int (Liste déroulante : Utilisateur)
Dernière action par
social_networks string
Réseaux Sociaux
proposed_candidates longtext (multiple)
Candidats Proposés
inline_partners string
Responsables
Liste des contacts
REQUEST
GET /contacts
RESPONSE
200 OK
{
"queryUid": "f5c8a96e894b4f7fc907244f3c0cab92",
"offset": 0,
"limit": 16,
"page": 1,
"pages": 1,
"total": 16,
"data": [
{
"id": 5274,
"label": "Olivier PETIT",
"contactid": 5274,
"uid": "1-174885208300a2974e2f69c658eafd7117e6e63a651c4",
"type": 1,
"reference": null,
"source": null,
"source_coopted_by_uid": "",
"source_employeeid": null,
"source_contactid": null,
"source_candidateid": null,
"source_coopted_by": null,
"campaignid": null,
"leadid": null,
"lead_since": null,
"civility": 1,
"status": 1,
"status_udate": "2025-06-02 10:14:43",
"companyid": null,
"owner_entityid": 101,
"owner_id": 43,
"owner_employeeid": 43,
"owner_contactid": null,
"related_entityid": null,
"related_objectid": null,
"customerid": null,
"contact_since": null,
"siteid": null,
"supplierid": null,
"candidateid": null,
"proid": null,
"profileids": null,
"has_access": 0,
"active": 1,
"first_name": "Olivier",
"last_name": "PETIT",
"birth_name": null,
"middle_name": null,
"headline": "",
"jobtitle": null,
"department": "",
"departmentid": null,
"locationid": null,
"locations": null,
"roomid": null,
"industryid": null,
"divisionid": null,
"divisions": null,
"inline_partners": null,
"analytic_account": null,
"profitcenterid": null,
"costcenterid": null,
"average_daily_rate": null,
"currency": null,
"external_reference": "",
"email": "",
"email2": "",
"communication_language": "fr",
"social_networks": null,
"linkedin_uid": null,
"linkedin_conversation_uid": null,
"apec_uid": null,
"phone1": null,
"phone1_region": null,
"phone1_ext": null,
"phone2": null,
"phone2_region": null,
"phone2_ext": null,
"phone3": null,
"phone3_region": null,
"phone4": null,
"phone4_region": null,
"street": "",
"zipcode": "75000",
"city": "Paris",
"country": "FR",
"lat": 48.86,
"lng": 2.34444,
"areaid": 991,
"area_level": 7,
"area_lvl1": 4,
"area_lvl2": 21,
"area_lvl3": 681,
"area_lvl4": 743,
"area_lvl5": 747,
"area_lvl6": 850,
"assistant": null,
"fax1": null,
"gender": "M",
"birth_date": null,
"picture": null,
"picture_location": null,
"assistant_name": null,
"assistant_phone": null,
"assistant_email": null,
"description": "",
"hashid": null,
"assignment_type": 1,
"last_activityid": null,
"last_action_on": null,
"last_action_by_userid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"last_meeting_minute_on": null,
"last_meeting_minuteid": null,
"last_noteid": null,
"last_callid": null,
"last_note_on": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"taskid": null,
"tags": null,
"has_opted_out_of_email": 0,
"has_opted_out_of_sms": 0,
"first_contact_on": null,
"indexing_status": 0,
"merging_log": null,
"bulkid": null,
"loekz": 0,
"cdate": "2025-06-02 10:14:39",
"cname": 46,
"udate": "2025-07-04 14:17:37",
"uname": 46,
"versi": 3
},
{
"id": 5266,
"label": "Jean-Jacques Rousseau",
"contactid": 5266,
"uid": "1-1724935248502553965718c56dfb6ed7ed2dc1cec1e53",
"type": 1,
"reference": null,
"source": null,
"source_coopted_by_uid": null,
"source_employeeid": null,
"source_contactid": null,
"source_candidateid": null,
"source_coopted_by": null,
"campaignid": null,
"leadid": null,
"lead_since": null,
"civility": null,
"status": 1,
"status_udate": "2024-08-29 14:40:48",
"companyid": null,
"owner_entityid": 101,
"owner_id": 43,
"owner_employeeid": 43,
"owner_contactid": null,
"related_entityid": null,
"related_objectid": null,
"customerid": null,
"contact_since": null,
"siteid": null,
"supplierid": null,
"candidateid": null,
"proid": null,
"profileids": null,
"has_access": 0,
"active": 1,
"first_name": "Jean-Jacques",
"last_name": "Rousseau",
"birth_name": null,
"middle_name": null,
"headline": "",
"jobtitle": null,
"department": "",
"departmentid": null,
"locationid": null,
"locations": null,
"roomid": null,
"industryid": null,
"divisionid": null,
"divisions": null,
"inline_partners": null,
"analytic_account": null,
"profitcenterid": null,
"costcenterid": null,
"average_daily_rate": null,
"currency": null,
"external_reference": "",
"email": "",
"email2": "",
"communication_language": "fr",
"social_networks": null,
"linkedin_uid": null,
"linkedin_conversation_uid": null,
"apec_uid": null,
"phone1": null,
"phone1_region": null,
"phone1_ext": null,
"phone2": null,
"phone2_region": null,
"phone2_ext": null,
"phone3": null,
"phone3_region": null,
"phone4": null,
"phone4_region": null,
"street": "",
"zipcode": "",
"city": "",
"country": "FR",
"lat": null,
"lng": null,
"areaid": 681,
"area_level": 3,
"area_lvl1": 4,
"area_lvl2": 21,
"area_lvl3": 681,
"area_lvl4": null,
"area_lvl5": null,
"area_lvl6": null,
"assistant": null,
"fax1": null,
"gender": null,
"birth_date": null,
"picture": null,
"picture_location": null,
"assistant_name": null,
"assistant_phone": null,
"assistant_email": null,
"description": "",
"hashid": null,
"assignment_type": 1,
"last_activityid": null,
"last_action_on": null,
"last_action_by_userid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"last_meeting_minute_on": null,
"last_meeting_minuteid": null,
"last_noteid": null,
"last_callid": null,
"last_note_on": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"taskid": null,
"tags": null,
"has_opted_out_of_email": 0,
"has_opted_out_of_sms": 0,
"first_contact_on": null,
"indexing_status": 0,
"merging_log": null,
"bulkid": null,
"loekz": 0,
"cdate": "2024-08-29 14:40:48",
"cname": 46,
"udate": "2024-08-29 14:40:48",
"uname": 46,
"versi": 1
}
]
}
Créer un nouveau contact
REQUEST
POST /contacts
{
"last_name": "Chartier"
}
RESPONSE
200 OK
{
"success": "Contact <b> Chartier</b> a été ajouté",
"object": {
"id": "5281",
"label": " Chartier",
"contactid": "5281",
"uid": "1-1757939320a73224d2168c419d7192222f50d4662b206",
"type": 1,
"reference": null,
"source": null,
"source_coopted_by_uid": null,
"source_employeeid": null,
"source_contactid": null,
"source_candidateid": null,
"source_coopted_by": null,
"campaignid": null,
"leadid": null,
"lead_since": null,
"civility": null,
"status": 1,
"status_udate": "2025-09-15 14:28:40",
"companyid": null,
"owner_entityid": null,
"owner_id": null,
"owner_employeeid": null,
"owner_contactid": null,
"related_entityid": null,
"related_objectid": null,
"customerid": null,
"contact_since": null,
"siteid": null,
"supplierid": null,
"candidateid": null,
"proid": null,
"profileids": null,
"has_access": 0,
"active": 1,
"first_name": null,
"last_name": "Chartier",
"birth_name": null,
"middle_name": null,
"headline": null,
"jobtitle": null,
"department": null,
"departmentid": null,
"locationid": null,
"locations": null,
"roomid": null,
"industryid": null,
"divisionid": null,
"divisions": null,
"inline_partners": null,
"analytic_account": null,
"profitcenterid": null,
"costcenterid": null,
"average_daily_rate": null,
"currency": null,
"external_reference": null,
"email": null,
"email2": null,
"communication_language": "fr",
"social_networks": null,
"linkedin_uid": null,
"linkedin_conversation_uid": null,
"apec_uid": null,
"phone1": null,
"phone1_region": null,
"phone1_ext": null,
"phone2": null,
"phone2_region": null,
"phone2_ext": null,
"phone3": null,
"phone3_region": null,
"phone4": null,
"phone4_region": null,
"street": null,
"zipcode": null,
"city": null,
"country": null,
"lat": null,
"lng": null,
"areaid": null,
"area_level": null,
"area_lvl1": null,
"area_lvl2": null,
"area_lvl3": null,
"area_lvl4": null,
"area_lvl5": null,
"area_lvl6": null,
"assistant": null,
"fax1": null,
"gender": null,
"birth_date": null,
"picture": null,
"picture_location": null,
"assistant_name": null,
"assistant_phone": null,
"assistant_email": null,
"description": null,
"hashid": null,
"assignment_type": "1",
"last_activityid": null,
"last_action_on": null,
"last_action_by_userid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"last_meeting_minute_on": null,
"last_meeting_minuteid": null,
"last_noteid": null,
"last_callid": null,
"last_note_on": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"taskid": null,
"tags": null,
"has_opted_out_of_email": 0,
"has_opted_out_of_sms": 0,
"first_contact_on": null,
"indexing_status": 0,
"merging_log": null,
"bulkid": null,
"loekz": 0,
"cdate": "2025-09-15 14:28:40",
"cname": 54,
"udate": "2025-09-15 14:28:40",
"uname": 54,
"versi": 1,
"initials": " C",
"consent_management_link": "https://master.nicoka.dev/public/contacts/consent/1-1757939320a73224d2168c419d7192222f50d4662b206/",
"unsubscribe_link": "https://master.nicoka.dev/public/subscriptions/unsubscribe/1-1757939320a73224d2168c419d7192222f50d4662b206/?eid=250&id=5281",
"portal_registering_link": "https://master.nicoka.dev/portal/?a=register&token=1-1757939320a73224d2168c419d7192222f50d4662b206&id=5281",
"name": " Chartier",
"updateLink": "?route=contacts/main&contactid=5281"
}
}
Récupérer un contact
Path params
Contactid (int)
Identifiant d'un contact
REQUEST
GET /contacts/{contactid}
RESPONSE
200 OK
{
"id": 5274,
"label": "Olivier PETIT",
"contactid": 5274,
"uid": "1-174885208300a2974e2f69c658eafd7117e6e63a651c4",
"type": 1,
"reference": null,
"source": null,
"source_coopted_by_uid": "",
"source_employeeid": null,
"source_contactid": null,
"source_candidateid": null,
"source_coopted_by": null,
"campaignid": null,
"leadid": null,
"lead_since": null,
"civility": 1,
"status": 1,
"status_udate": "2025-06-02 10:14:43",
"companyid": null,
"owner_entityid": 101,
"owner_id": 43,
"owner_employeeid": 43,
"owner_contactid": null,
"related_entityid": null,
"related_objectid": null,
"customerid": null,
"contact_since": null,
"siteid": null,
"supplierid": null,
"candidateid": null,
"proid": null,
"profileids": null,
"has_access": 0,
"active": 1,
"first_name": "Olivier",
"last_name": "PETIT",
"birth_name": null,
"middle_name": null,
"headline": "",
"jobtitle": null,
"department": "",
"departmentid": null,
"locationid": null,
"locations": null,
"roomid": null,
"industryid": null,
"divisionid": null,
"divisions": null,
"inline_partners": null,
"analytic_account": null,
"profitcenterid": null,
"costcenterid": null,
"average_daily_rate": null,
"currency": null,
"external_reference": "",
"email": "",
"email2": "",
"communication_language": "fr",
"social_networks": null,
"linkedin_uid": null,
"linkedin_conversation_uid": null,
"apec_uid": null,
"phone1": null,
"phone1_region": null,
"phone1_ext": null,
"phone2": null,
"phone2_region": null,
"phone2_ext": null,
"phone3": null,
"phone3_region": null,
"phone4": null,
"phone4_region": null,
"street": "",
"zipcode": "75000",
"city": "Paris",
"country": "FR",
"lat": 48.86,
"lng": 2.34444,
"areaid": 991,
"area_level": 7,
"area_lvl1": 4,
"area_lvl2": 21,
"area_lvl3": 681,
"area_lvl4": 743,
"area_lvl5": 747,
"area_lvl6": 850,
"assistant": null,
"fax1": null,
"gender": "M",
"birth_date": null,
"picture": null,
"picture_location": null,
"assistant_name": null,
"assistant_phone": null,
"assistant_email": null,
"description": "",
"hashid": null,
"assignment_type": 1,
"last_activityid": null,
"last_action_on": null,
"last_action_by_userid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"last_meeting_minute_on": null,
"last_meeting_minuteid": null,
"last_noteid": null,
"last_callid": null,
"last_note_on": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"taskid": null,
"tags": null,
"has_opted_out_of_email": 0,
"has_opted_out_of_sms": 0,
"first_contact_on": null,
"indexing_status": 0,
"merging_log": null,
"bulkid": null,
"loekz": 0,
"cdate": "2025-06-02 10:14:39",
"cname": 46,
"udate": "2025-07-04 14:17:37",
"uname": 46,
"versi": 3,
"initials": "O P",
"consent_management_link": "https://master.nicoka.dev/public/contacts/consent/1-174885208300a2974e2f69c658eafd7117e6e63a651c4/",
"unsubscribe_link": "https://master.nicoka.dev/public/subscriptions/unsubscribe/1-174885208300a2974e2f69c658eafd7117e6e63a651c4/?eid=250&id=5274",
"portal_registering_link": "https://master.nicoka.dev/portal/?a=register&token=1-174885208300a2974e2f69c658eafd7117e6e63a651c4&id=5274",
"name": "Olivier PETIT",
"updateLink": "?route=contacts/main&contactid=5274"
}
Activité
Overview
Attributes
activityid int
ID Système
customerid int (Liste déroulante : Compte)
Compte
supplierid int (Liste déroulante : Fournisseur)
Fournisseur
related_entityid int (Liste déroulante : Entité)
Entité
Endpoint de récupération des valeurs: /application/entities/2/values/
parent_activityid int (Liste déroulante : Action)
Action parent
contactid int (Liste déroulante : Contact)
Contact
related_objectid int
Objet de liaison
poid int (Liste déroulante : Commande d'Achat)
Commande d'Achat
piid int (Liste déroulante : Facture d'achat)
Facture d'achat
opid int (Liste déroulante : Opportunité)
Opportunité
quotationid int (Liste déroulante : Devis)
Devis
orderid int (Liste déroulante : Commande)
Commande
invoiceid int (Liste déroulante : Facture)
Facture
type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/264/values/
call_type int
Type d'appel
projectid int (Liste déroulante : Projet)
Projet
call_status int (Liste déroulante : Statut de l'appel)
Statut de l'appel
Endpoint de récupération des valeurs: /application/entities/279/values/
messageid int (Liste déroulante : Message)
Message
Endpoint de récupération des valeurs: /application/entities/1091/values/
call_purposeid int (Liste déroulante : Objet de l'appel)
Objet de l'appel
Endpoint de récupération des valeurs: /application/entities/277/values/
jobid int (Liste déroulante : Mission)
Mission
reached boolean
Abouti
timezone string
Fuseau Horaire
completed boolean
Effectué
templateid int (Liste déroulante : Template d'email)
Template d'email
Endpoint de récupération des valeurs: /application/entities/1100/values/
external_reference string
Réf. Externe
taskid int (Liste déroulante : Tâche)
Tâche
Endpoint de récupération des valeurs: /application/entities/60/values/
subject string
Sujet
eventid int (Liste déroulante : Evénement)
Evénement
comments longtext
Commentaires
locationid int (Liste déroulante : Agence)
Agence
cdate datetime
Créé le
roomid int (Liste déroulante : Bureau/Salle)
Bureau/Salle
Endpoint de récupération des valeurs: /application/entities/93/values/
event_type int (Liste déroulante : Type d'évènement)
Type d'évènement
Endpoint de récupération des valeurs: /application/entities/856/values/
date datetime
Date
cname int (Liste déroulante : Utilisateur)
Créé par
task_type int (Liste déroulante : Type de tâche)
Type de tâche
Endpoint de récupération des valeurs: /application/entities/65/values/
udate datetime
MàJ le
duration int
Durée
uname int (Liste déroulante : Utilisateur)
MàJ par
next_action_taskid int (Liste déroulante : Tâche)
Action suivante tâche
Endpoint de récupération des valeurs: /application/entities/60/values/
prospection boolean
Prospection
Liste des activités
REQUEST
GET /crmActivities
RESPONSE
200 OK
[
{
"id": 2919984,
"activityid": 2919984,
"parent_activityid": null,
"customerid": 2184,
"supplierid": null,
"contactid": null,
"leadid": null,
"prospection": 0,
"requestid": null,
"poid": null,
"piid": null,
"opid": null,
"quotationid": null,
"orderid": null,
"invoiceid": 7838,
"projectid": null,
"jobid": null,
"candidateid": null,
"hse_domainid": null,
"doctype": null,
"type": 3,
"external_reference": null,
"pin": 1,
"call_purposeid": null,
"call_type": null,
"call_status": null,
"reached": 0,
"entityid": 101,
"objectid": 35,
"author": "Fanny G",
"related_entityid": 1540,
"related_objectid": 7838,
"related_label": "F25-00140",
"related_sub_entityid": null,
"related_sub_objectid": null,
"templateid": null,
"messageid": 539828,
"boxid": 26,
"message_uid": null,
"smsid": null,
"hashid": "26-2025-10-31-d9273139aafceacd5",
"eventid": null,
"event_type": null,
"roomid": null,
"locationid": null,
"taskid": null,
"task_type": null,
"surveyid": null,
"survey_modelid": null,
"model_versi": null,
"transcriptid": null,
"score": null,
"date": "2025-10-31 09:55:57",
"timezone": null,
"duration": null,
"duration_unit": null,
"start": null,
"end": null,
"fullday": null,
"completed": 1,
"subject": "Facture F25-00140",
"comments": "Bonjour,\u003Cbr\u003E\u003Cbr\u003EVous trouverez ci-joint votre facture pour la période du 01/11/2025 au 30/11/2025. \u003Cbr\u003ESoit un montant total de 3 088,80 € TTC.\u003Cbr\u003E\u003Cbr\u003EVous pouvez également consulter votre facture en ligne, cliquez le lien suivant : \u003Ca href=\"https://mondomaine.nicoka.com/public/sales/invoices/\"\u003EF25-001740\u003C/a\u003E \u003Cbr\u003E\u003Cbr\u003EBonne journée,\u003Cbr\u003E\u003Cbr\u003E...",
"reactions": null,
"inline_targets": "[{\"role\":1,\"entityid\":\"250\",\"id\":\"4074\",\"label\":\"Charles D\",\"email\":\"charles.d@cabinet.fr\"}]",
"inline_files": "[{\"file\":\"TRUC-F25-001740.pdf\",\"uid\":\"2-1761900957yZOXEcbcbzHFdz3nSSUY5vz73ZJlRbG4FY\",\"aid\":1}]",
"associations": null,
"params": null,
"next_actionid": null,
"next_action_subject": null,
"next_action_duedate": null,
"next_action_comments": null,
"next_action_taskid": null,
"next_action_targetid": null,
"next_action_notify": 0,
"indexing_status": null,
"loekz": 0,
"cdate": "2025-10-31 09:55:57",
"cname": 38,
"udate": "2025-11-06 17:21:54",
"uname": 1,
"versi": 2,
"modelid": 3,
"icon": "fa fa-envelope",
"color": "#7bd148",
"actions": [],
"isEmail": true,
"label": "\u003Cb\u003EMessage\u003C/b\u003E envoyé par \u003Cspan class=\"ui-author bold\"\u003EFanny\u003C/span\u003E",
"replyLink": "?route=crm/activities/reply/&activityid=2919984",
"showViewsLink": "?route=messages/views/&messageid=539828",
"showViewsTitle": "Afficher les vues",
"nbOfViews": 8,
"preview": "?route=inbox/messages/viewer/&messageid=539828",
"editable": false,
"editActivity": "Editer l'activité en double cliquant",
"dateTooltip": "12 jours",
"dateLabel": "31/10/2025 09:55",
"bg_color": "#7bd148",
"tos": [
{
"role": 1,
"entityid": "250",
"id": "4074",
"label": "Charles D",
"email": "charles@cabinet.fr",
"link": "?route=contacts/main&contactid=4074"
}
],
"relatedLink": "?route=sales/invoices/invoice&invoiceid=7838",
"relatedIcon": "far fa-file-invoice-dollar",
"files": [
{
"file": "APTIC-F25-001740.pdf",
"uid": "2-1761900957yZOXEcbcbdqKfSO8cRp2zHFdz3nSSUY5vz73ZJlRbG4FY",
"aid": 1,
"filename": "APTIC-F25-001740.pdf",
"icon": "far fa-file-pdf",
"short": "APTIC-F25-001740",
"isAudio": false
}
],
"uri": "?route=crm/activities/&inlineid=2919984&xvtrs=1",
"updateLink": null,
"deleteLink": "?route=crm/activities/delete&inlineid=2919984&xvtrs=1",
"pinLink": "?route=crm/api/&request=activities--2919984",
"pinAuthorization": true,
"listPinActivities": [],
"objectId": 7838,
"viewActivities": "",
"activityUid": "263__2919984",
"changeRelatedLink": "?route=crm/activities/link/&activityid=2919984"
}
]
Créer une nouvelle activité
REQUEST
POST /crmActivities
{
"contactid": 7900,
"type" : 2
}
RESPONSE
200 OK
{
"success": "Activité <b>Appel</b> a été ajoutée",
"object": {
"id": "2909666",
"label": "Appel",
"activityid": "2909666",
"parent_activityid": null,
"customerid": 13917,
"supplierid": null,
"contactid": 7900,
"leadid": null,
"prospection": 0,
"requestid": null,
"poid": null,
"piid": null,
"opid": null,
"quotationid": null,
"orderid": null,
"invoiceid": null,
"projectid": null,
"jobid": null,
"candidateid": null,
"hse_domainid": null,
"doctype": null,
"type": 2,
"external_reference": null,
"pin": 0,
"call_purposeid": null,
"call_type": null,
"call_status": null,
"reached": 0,
"entityid": 1,
"objectid": 55,
"author": "Utilisateur API",
"related_entityid": 250,
"related_objectid": 7900,
"related_label": "Edouard LONGCHAMBON",
"related_sub_entityid": null,
"related_sub_objectid": null,
"templateid": null,
"messageid": null,
"boxid": null,
"message_uid": null,
"smsid": null,
"hashid": null,
"eventid": null,
"event_type": null,
"roomid": null,
"locationid": null,
"taskid": null,
"task_type": null,
"surveyid": null,
"survey_modelid": null,
"model_versi": null,
"transcriptid": null,
"score": null,
"date": "2025-12-05 16:46:08",
"timezone": null,
"duration": null,
"duration_unit": null,
"start": null,
"end": null,
"fullday": null,
"completed": 0,
"subject": null,
"comments": null,
"reactions": null,
"inline_targets": null,
"inline_files": null,
"associations": null,
"params": null,
"next_actionid": null,
"next_action_subject": null,
"next_action_duedate": null,
"next_action_comments": null,
"next_action_taskid": null,
"next_action_targetid": null,
"next_action_notify": 0,
"indexing_status": null,
"loekz": 0,
"cdate": "2025-12-05 16:46:07",
"cname": 55,
"udate": "2025-12-05 16:46:07",
"uname": 55,
"versi": 1,
"start_time": "16:46",
"related": "250__7900",
"made_by_uid": "1__55",
"related_to_uid": "250__7900",
"updateLink": "?route=contacts/activities&activityid=2909666"
}
}
Récupérer une activité
Path params
Activityid (int)
Identifiant d'une activité
REQUEST
GET /crmActivities/{activityid}
RESPONSE
200 OK
{
"id": 2919984,
"label": "Courriel envoyé",
"activityid": 2919984,
"parent_activityid": null,
"customerid": 2184,
"supplierid": null,
"contactid": null,
"leadid": null,
"prospection": 0,
"requestid": null,
"poid": null,
"piid": null,
"opid": null,
"quotationid": null,
"orderid": null,
"invoiceid": 7838,
"projectid": null,
"jobid": null,
"candidateid": null,
"hse_domainid": null,
"doctype": null,
"type": 3,
"external_reference": null,
"pin": 1,
"call_purposeid": null,
"call_type": null,
"call_status": null,
"reached": 0,
"entityid": 101,
"objectid": 35,
"author": "Fanny",
"related_entityid": 1540,
"related_objectid": 7838,
"related_label": "F25-001740",
"related_sub_entityid": null,
"related_sub_objectid": null,
"templateid": null,
"messageid": 539828,
"boxid": 26,
"message_uid": null,
"smsid": null,
"hashid": "26-2025-10-31-d9273139aafce55935b2d2cd5",
"eventid": null,
"event_type": null,
"roomid": null,
"locationid": null,
"taskid": null,
"task_type": null,
"surveyid": null,
"survey_modelid": null,
"model_versi": null,
"transcriptid": null,
"score": null,
"date": "2025-10-31 09:55:57",
"timezone": null,
"duration": null,
"duration_unit": null,
"start": null,
"end": null,
"fullday": null,
"completed": 1,
"subject": "Facture F25-00140",
"comments": "Bonjour Charles,\u003Cbr\u003E\u003Cbr\u003EVous trouverez ci-joint votre facture pour la période du 01/11/2025 au 30/11/2025. \u003Cbr\u003ESoit un montant total de 3 088,80 € TTC.\u003Cbr\u003E\u003Cbr\u003EVous pouvez également consulter votre facture en ligne, cliquez le lien suivant : \u003Ca href=\"https://mondomaine.nicoka.com/public/sales/invoices/2-17618132869eb885f24e07f167ffa85c\"\u003EF25-001740\u003C/a\u003E \u003Cbr\u003E\u003Cbr\u003EBonne journée,\u003Cbr\u003E\u003Cbr\u003E...",
"reactions": null,
"inline_targets": "[{\"role\":1,\"entityid\":\"250\",\"id\":\"4074\",\"label\":\"Charles\",\"email\":\"charles@cabinet.fr\"}]",
"inline_files": "[{\"file\":\"TRUC-F25-001740.pdf\",\"uid\":\"2-1761900957yZOXEcbcbdqKfS2zHFdz3nSSUY5vz73ZJlRbG4FY\",\"aid\":1}]",
"associations": null,
"params": null,
"next_actionid": null,
"next_action_subject": null,
"next_action_duedate": null,
"next_action_comments": null,
"next_action_taskid": null,
"next_action_targetid": null,
"next_action_notify": 0,
"indexing_status": null,
"loekz": 0,
"cdate": "2025-10-31 09:55:57",
"cname": 38,
"udate": "2025-11-06 17:21:54",
"uname": 1,
"versi": 2,
"start_time": "09:55",
"related": "1540__7838",
"made_by_uid": "101__35",
"related_to_uid": "1540__7838",
"updateLink": "?route=contacts/activities&activityid=2919984"
}
Opportunité
Overview
Attributes
opid int
ID Système
label string
Libellé
type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/1481/values/
stage int (Liste déroulante : Etape de vente)
Etape de vente
Endpoint de récupération des valeurs: /application/entities/1482/values/
sourceid int (Liste déroulante : Provenance)
Provenance
Endpoint de récupération des valeurs: /application/entities/262/values/
reference string
Référence
stage_date datetime
Etape MàJ le
customerid int (Liste déroulante : Compte)
Compte
previous_stage int (Liste déroulante : Etape de vente)
Etape précédente
Endpoint de récupération des valeurs: /application/entities/1482/values/
contactid int (Liste déroulante : Contact)
Contact
compid int (Liste déroulante : Société)
Société
assignment_type int
Visible par
close_date date
Date de clôture
divisionid int (Liste déroulante : Zone d'intervention)
Zone d'intervention
Endpoint de récupération des valeurs: /application/entities/104/values/
locationid int (Liste déroulante : Agence)
Agence
amount double
Montant (€ HT Annuel)
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
unit int (Liste déroulante : Unité)
Unité
Endpoint de récupération des valeurs: /application/entities/1510/values/
probability string
Probabilité
price double
Prix
description string (TEXT)
Description
last_activityid int (Liste déroulante : Activité)
Dernière action
unitary_cost double
Coût unitaire
rate string
Taux
assign_to_entityid int (Liste déroulante : Entité)
Assigné à (Id Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/
quantity float
Qté.
last_action_on datetime
Dernière action le
assign_to_objectid string
Assigné à (Id)
period_end date
Période (Fin)
taskid int (Liste déroulante : Tâche)
Dernière Tâche
Endpoint de récupération des valeurs: /application/entities/60/values/
period_unit int
Période (Unité)
related_to_entityid int (Liste déroulante : Entité)
En référence à
Endpoint de récupération des valeurs: /application/entities/2/values/
period_start date
Période (début)
period_quantity float
Période (Qté)
closing_comments string (TEXT)
Commentaires (Motif de clôture)
closing_reasonid int (Liste déroulante : Motif de clôture)
Motif de clôture
Endpoint de récupération des valeurs: /application/entities/1490/values/
assign_to_employeeid int (Liste déroulante : Collaborateur)
Collaborateur
cost double
Coût
margin double
Marge commerciale
cdate datetime
Créé le
margin_rate string
% de Marge
udate datetime
MàJ le
cname int (Liste déroulante : Utilisateur)
Créé par
tags longtext (multiple)
Tags
Endpoint de récupération des valeurs: /application/entities/1488/values/
uname int (Liste déroulante : Utilisateur)
MàJ par
nb_of_open_tasks int
Nb. de tâches en cours
nb_of_tasks int
Nb. de tâches
last_noteid longtext
Dernière note
Liste des opportunités
REQUEST
GET /opportunities
RESPONSE
200 OK
{
"queryUid": "edf4246c94fbb7471bd1b78c4c7828e8",
"offset": 0,
"limit": 1,
"page": 1,
"pages": 1,
"total": 1,
"data": [
{
"id": 2390,
"label": "Contrat prestation technique",
"opid": 2390,
"uid": "3-176233385056dec9109b1194e9ebd70b6a8dfce93de24",
"type": 2,
"sourceid": null,
"source_coopted_by_uid": null,
"source_employeeid": null,
"source_contactid": null,
"source_candidateid": null,
"source_coopted_by": null,
"stage": 1,
"stage_date": "2025-11-05 10:10:50",
"previous_stage": null,
"reference": null,
"customerid": 13917,
"contactid": 7900,
"siteid": null,
"compid": 1,
"locationid": null,
"divisionid": null,
"related_to_entityid": null,
"related_to_objectid": null,
"projectid": null,
"assign_to_entityid": 101,
"assign_to_objectid": 51,
"assign_to_name": "Céline CH",
"assign_to_employeeid": 51,
"assign_to_contactid": null,
"assignment_type": 1,
"close_date": null,
"last_activityid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"last_meeting_minute_on": null,
"last_note_on": null,
"last_noteid": null,
"last_action_on": null,
"inline_jobs": null,
"inline_contributors":"{\"101__51\":{\"id\":\"101__51\",\"name\":\"CCH\"}}",
"inline_files": null,
"taskid": null,
"amount": null,
"currency": "EUR",
"probability": 50,
"quantity": null,
"rate": null,
"unit": 2,
"period_start": null,
"period_end": null,
"period_quantity": null,
"period_unit": null,
"price": null,
"unitary_cost": null,
"cost": null,
"margin": null,
"margin_rate": "0.0000",
"invoicing_modeid": null,
"description": "La description",
"params": null,
"tags": null,
"closing_reasonid": null,
"closing_comments": null,
"indexing_status": null,
"loekz": 0,
"cdate": "2025-11-05 10:10:49",
"cname": 55,
"udate": "2025-11-05 10:12:27",
"uname": 54,
"versi": 3
}
]
}
Créer une nouvelle opportunité
REQUEST
POST /opportunities
{
"label": "Prestation commerciale",
"customerid" : 13917,
"stage" : 3
}
RESPONSE
200 OK
{
"success": "Opportunité <b>Prestation commerciale</b> a été ajoutée",
"object": {
"id": "2391",
"label": "Prestation commerciale",
"opid": "2391",
"uid": "3-17623350162fec1caca1f5f45c5f15bbff6cc59d00a6b",
"type": 2,
"sourceid": null,
"source_coopted_by_uid": null,
"source_employeeid": null,
"source_contactid": null,
"source_candidateid": null,
"source_coopted_by": null,
"stage": 3,
"stage_date": "2025-11-05 10:30:16",
"previous_stage": null,
"reference": null,
"customerid": "13917",
"contactid": null,
"siteid": null,
"compid": "1",
"locationid": null,
"divisionid": null,
"related_to_entityid": null,
"related_to_objectid": null,
"projectid": null,
"assign_to_entityid": null,
"assign_to_objectid": null,
"assign_to_name": null,
"assign_to_employeeid": null,
"assign_to_contactid": null,
"assignment_type": "1",
"close_date": null,
"last_activityid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"last_meeting_minute_on": null,
"last_note_on": null,
"last_noteid": null,
"last_action_on": null,
"inline_jobs": null,
"inline_contributors": null,
"inline_files": null,
"taskid": null,
"amount": null,
"currency": null,
"probability": null,
"quantity": null,
"rate": null,
"unit": 2,
"period_start": null,
"period_end": null,
"period_quantity": null,
"period_unit": null,
"price": null,
"unitary_cost": null,
"cost": null,
"margin": null,
"margin_rate": 0,
"invoicing_modeid": null,
"description": null,
"params": null,
"tags": null,
"closing_reasonid": null,
"closing_comments": null,
"indexing_status": null,
"loekz": 0,
"cdate": "2025-11-05 10:30:16",
"cname": 55,
"udate": "2025-11-05 10:30:16",
"uname": 55,
"versi": 1,
"updateLink": "?route=opportunities/main&opid=2391"
}
}
Récupérer une opportunité
Path params
Opportunityid (int)
Identifiant d'une opportunité
REQUEST
GET /opportunities/{opportunityid}
RESPONSE
200 OK
{
"id": 2390,
"label": "Contrat prestation technique",
"opid": 2390,
"uid": "3-176233385056dec9109b1194e9ebd70b6a8dfce93de24",
"type": 2,
"sourceid": null,
"source_coopted_by_uid": null,
"source_employeeid": null,
"source_contactid": null,
"source_candidateid": null,
"source_coopted_by": null,
"stage": 1,
"stage_date": "2025-11-05 10:10:50",
"previous_stage": null,
"reference": null,
"customerid": 13917,
"contactid": 7900,
"siteid": null,
"compid": 1,
"locationid": null,
"divisionid": null,
"related_to_entityid": null,
"related_to_objectid": null,
"projectid": null,
"assign_to_entityid": 101,
"assign_to_objectid": 51,
"assign_to_name": "Céline CH",
"assign_to_employeeid": 51,
"assign_to_contactid": null,
"assignment_type": 1,
"close_date": null,
"last_activityid": null,
"last_email_sent_on": null,
"last_email_received_on": null,
"last_phone_call_on": null,
"last_phone_successful_call_on": null,
"last_meeting_on": null,
"nb_of_open_tasks": null,
"nb_of_tasks": null,
"last_meeting_minute_on": null,
"last_note_on": null,
"last_noteid": null,
"last_action_on": null,
"inline_jobs": null,
"inline_contributors":"{\"101__51\":{\"id\":\"101__51\",\"name\":\"CCH\"}}",
"inline_files": null,
"taskid": null,
"amount": null,
"currency": "EUR",
"probability": 50,
"quantity": null,
"rate": null,
"unit": 2,
"period_start": null,
"period_end": null,
"period_quantity": null,
"period_unit": null,
"price": null,
"unitary_cost": null,
"cost": null,
"margin": null,
"margin_rate": "0.0000",
"invoicing_modeid": null,
"description": "La description",
"params": null,
"tags": null,
"closing_reasonid": null,
"closing_comments": null,
"indexing_status": null,
"loekz": 0,
"cdate": "2025-11-05 10:10:49",
"cname": 55,
"udate": "2025-11-05 10:12:27",
"uname": 54,
"versi": 3,
"updateLink": "?route=opportunities/main&opid=2390"
}