> For the complete documentation index, see [llms.txt](https://geosquare-1.gitbook.io/geosquare-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://geosquare-1.gitbook.io/geosquare-docs/contact-prospects.md).

# Contact Prospects

## List prospects

> Retrieve list of prospects with filtering and pagination support. Prospect. \
> \
> &#x20;

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"contact_prospect_list":{"type":"object","properties":{"models":{"type":"array","items":{"$ref":"#/components/schemas/contact_prospect_list_item"}},"total_count":{"type":"integer","description":"Total number of items"}},"required":["models","total_count"]},"contact_prospect_list_item":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"code":{"type":["string","null"],"description":"Code Client"},"origin_id":{"type":["integer","string","null"],"description":"Type de tiers"},"source_id":{"type":["integer","string","null"],"description":"Origine du contact"},"person_id":{"type":["integer","string","null"],"description":"Person id"},"address_id":{"type":["integer","string","null"],"description":"Address id"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"manager_id":{"type":["integer","string","null"],"description":"Commercial"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"account_number":{"type":["null","string"]},"internal":{"type":["null","boolean"]},"created_at":{"type":["string","null"],"description":"Date de création"},"_address":{"type":["string","null"],"description":"Adresse"},"cp":{"type":["string","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"email":{"type":["string","null"],"format":"email","description":"Email"},"origin":{"type":["object","null"],"properties":{"color":{"type":["string","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"manager":{"type":["string","null"],"description":"Commercial"},"agency":{"type":["string","null"],"description":"Agence"},"source":{"type":["string","null"],"description":"Origine du contact"},"is_prospect":{"type":["boolean","null"],"description":"Is prospect"},"person":{"type":["object","null"],"properties":{"identity":{"type":["string","null"],"description":"Identity"}},"required":[],"additionalProperties":true},"address":{"type":["object","null"],"properties":{"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"cp":{"type":["string","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"country_id":{"type":["integer","string","null"],"description":"Pays"},"country":{"type":"null","description":"Pays"},"representation":{"type":["string","null"],"description":"Nom"},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"account_number_fmt":{"type":["string","null"],"description":"Numéro de compte"},"unpaid_total_solde":{"type":["integer","null"],"description":"Total non payé (T.T.C)"}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name"],"additionalProperties":true}}},"paths":{"/prospects":{"get":{"summary":"List prospects","tags":["Contact - Prospects"],"description":"Retrieve list of prospects with filtering and pagination support. Prospect. \n\n ","parameters":[{"name":"search","in":"query","required":false,"description":"Tableau des différents attributs de recherche","schema":{"type":"object","properties":{"type_contact_id":{"type":"integer","description":"Type de tiers"},"person_id":{"type":"integer","description":"Person id"},"address_id":{"type":"integer","description":"Address id"},"comment":{"type":"string","description":"Précisions"},"created_by_id":{"type":"integer","description":"Created by id"},"updated_by_id":{"type":"integer","description":"Updated by id"},"inactivated_at":{"type":"string","description":"Archivé le"},"type":{"type":"string","description":"Type"},"code":{"type":"string","description":"Code Client"},"origin_id":{"type":"integer","description":"Type de tiers"},"sector_id":{"type":"integer","description":"Secteur d'activité"},"manager_id":{"type":"integer","description":"Commercial"},"account_number":{"type":"string","description":"Numéro de compte"},"logo":{"type":"string","description":"Logo"},"agency_id":{"type":"integer","description":"Agence"},"source_id":{"type":"integer","description":"Origine du contact"},"interconnection_id":{"type":"integer","description":"Interconnection id"},"internal":{"type":"boolean","description":"Interne"},"commission_id":{"type":"integer","description":"Commission id"},"import_json":{"type":"object","description":"Import json"},"dealv1_partner_id":{"type":"integer","description":"Dealv1 partner id"},"dealv1_logo_filename":{"type":"string","description":"Dealv1 logo filename"},"import_file_ok":{"type":"string","description":"Import file ok"},"import_file_error":{"type":"string","description":"Import file error"},"intervenant_type_id":{"type":"integer","description":"Intervenant type id"},"person":{"type":"string","description":"Personne"},"representation":{"type":"string","description":"Nom"},"index_search":{"type":"string","description":"Index search"},"email":{"type":"string","description":"Email"},"phone":{"type":"string","description":"Téléphone"},"portable":{"type":"string","description":"Mobile"},"_address":{"type":"string","description":"Adresse"},"cp":{"type":"string","description":"Code postal"},"city":{"type":"string","description":"Ville"},"country_id":{"type":"integer","description":"Pays"},"payment_mode":{"type":"string","description":"Mode de règlement"},"country":{"type":"string","description":"Pays"},"account_number_fmt":{"type":"string","description":"Numéro de compte"},"unpaid_total_solde":{"type":"string","description":"Total non payé (T.T.C)"},"exact_code":{"type":"string","description":"Exact code"}},"additionalProperties":false}},{"name":"sort","in":"query","required":false,"description":"Tableau des différents attributs","schema":{"type":"object","properties":{"type_contact_id":{"type":"string","description":"type_contact_id DESC NULLS LAST(Descendant) ou type_contact_id (Ascendant)"},"person_id":{"type":"string","description":"person_id DESC NULLS LAST(Descendant) ou person_id (Ascendant)"},"address_id":{"type":"string","description":"address_id DESC NULLS LAST(Descendant) ou address_id (Ascendant)"},"comment":{"type":"string","description":"comment DESC NULLS LAST(Descendant) ou comment (Ascendant)"},"created_by_id":{"type":"string","description":"created_by_id DESC NULLS LAST(Descendant) ou created_by_id (Ascendant)"},"updated_by_id":{"type":"string","description":"updated_by_id DESC NULLS LAST(Descendant) ou updated_by_id (Ascendant)"},"inactivated_at":{"type":"string","description":"inactivated_at DESC NULLS LAST(Descendant) ou inactivated_at (Ascendant)"},"type":{"type":"string","description":"type DESC NULLS LAST(Descendant) ou type (Ascendant)"},"code":{"type":"string","description":"code DESC NULLS LAST(Descendant) ou code (Ascendant)"},"origin_id":{"type":"string","description":"origin_id DESC NULLS LAST(Descendant) ou origin_id (Ascendant)"},"manager_id":{"type":"string","description":"manager_id DESC NULLS LAST(Descendant) ou manager_id (Ascendant)"},"account_number":{"type":"string","description":"account_number DESC NULLS LAST(Descendant) ou account_number (Ascendant)"},"logo":{"type":"string","description":"logo DESC NULLS LAST(Descendant) ou logo (Ascendant)"},"source_id":{"type":"string","description":"source_id DESC NULLS LAST(Descendant) ou source_id (Ascendant)"},"interconnection_id":{"type":"string","description":"interconnection_id DESC NULLS LAST(Descendant) ou interconnection_id (Ascendant)"},"internal":{"type":"string","description":"internal DESC NULLS LAST(Descendant) ou internal (Ascendant)"},"commission_id":{"type":"string","description":"commission_id DESC NULLS LAST(Descendant) ou commission_id (Ascendant)"},"import_json":{"type":"string","description":"import_json DESC NULLS LAST(Descendant) ou import_json (Ascendant)"},"dealv1_partner_id":{"type":"string","description":"dealv1_partner_id DESC NULLS LAST(Descendant) ou dealv1_partner_id (Ascendant)"},"dealv1_logo_filename":{"type":"string","description":"dealv1_logo_filename DESC NULLS LAST(Descendant) ou dealv1_logo_filename (Ascendant)"},"import_file_ok":{"type":"string","description":"import_file_ok DESC NULLS LAST(Descendant) ou import_file_ok (Ascendant)"},"import_file_error":{"type":"string","description":"import_file_error DESC NULLS LAST(Descendant) ou import_file_error (Ascendant)"},"intervenant_type_id":{"type":"string","description":"intervenant_type_id DESC NULLS LAST(Descendant) ou intervenant_type_id (Ascendant)"},"person":{"type":"string","description":"person DESC NULLS LAST(Descendant) ou person (Ascendant)"},"representation":{"type":"string","description":"representation DESC NULLS LAST(Descendant) ou representation (Ascendant)"},"email":{"type":"string","description":"email DESC NULLS LAST(Descendant) ou email (Ascendant)"},"phone":{"type":"string","description":"phone DESC NULLS LAST(Descendant) ou phone (Ascendant)"},"portable":{"type":"string","description":"portable DESC NULLS LAST(Descendant) ou portable (Ascendant)"},"_address":{"type":"string","description":"_address DESC NULLS LAST(Descendant) ou _address (Ascendant)"},"cp":{"type":"string","description":"cp DESC NULLS LAST(Descendant) ou cp (Ascendant)"},"city":{"type":"string","description":"city DESC NULLS LAST(Descendant) ou city (Ascendant)"},"country_id":{"type":"string","description":"country_id DESC NULLS LAST(Descendant) ou country_id (Ascendant)"},"payment_mode":{"type":"string","description":"payment_mode DESC NULLS LAST(Descendant) ou payment_mode (Ascendant)"},"country":{"type":"string","description":"country DESC NULLS LAST(Descendant) ou country (Ascendant)"},"account_number_fmt":{"type":"string","description":"account_number_fmt DESC NULLS LAST(Descendant) ou account_number_fmt (Ascendant)"},"agency_id":{"type":"string","description":"agency_id DESC NULLS LAST(Descendant) ou agency_id (Ascendant)"},"sector_id":{"type":"string","description":"sector_id DESC NULLS LAST(Descendant) ou sector_id (Ascendant)"},"unpaid_total_solde":{"type":"string","description":"unpaid_total_solde DESC NULLS LAST(Descendant) ou unpaid_total_solde (Ascendant)"}},"additionalProperties":false}},{"name":"page","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Number of items per page (-1 for all items/options mode)","schema":{"type":"integer"}},{"name":"scope","in":"query","required":false,"description":"Filter scope to apply","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Filter by tag name","schema":{"type":"string"}},{"name":"with_deleted","in":"query","required":false,"description":"Include soft-deleted items (1 to include, 0 or omit to exclude)","schema":{"type":"integer"}},{"name":"only_deleted","in":"query","required":false,"description":"Show only soft-deleted items (1 for only deleted)","schema":{"type":"integer"}},{"name":"with_inactivated","in":"query","required":false,"description":"Include inactivated items (1 to include)","schema":{"type":"integer"}},{"name":"only_inactivated","in":"query","required":false,"description":"Show only inactivated items (1 for only inactivated)","schema":{"type":"integer"}},{"name":"force_sort","in":"query","required":false,"description":"Force sorting even when custom search is used","schema":{"type":"string"}},{"name":"group_ids","in":"query","required":false,"description":"Comma-separated group IDs to filter by","schema":{"type":"string"}},{"name":"json_format","in":"query","required":false,"description":"Custom serialization format","schema":{"type":"string"}}],"responses":{"200":{"description":"List retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_list"}}}},"401":{"description":"Unauthorized - Invalid token"}}}}}}
```

## Create prospect

> Create a new Contact prospect. Prospect

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"contact_prospect_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Date de création"},"updated_at":{"type":["string","null"],"description":"Date de modification"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"code":{"type":["string","null"],"description":"Code Client"},"origin_id":{"type":["integer","string","null"],"description":"Type de tiers"},"source_id":{"type":["integer","string","null"],"description":"Origine du contact"},"person_id":{"type":["integer","string","null"],"description":"Person id"},"address_id":{"type":["integer","string","null"],"description":"Address id"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"manager_id":{"type":["integer","string","null"],"description":"Commercial"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"account_number":{"type":["null","string"]},"internal":{"type":["null","boolean"]},"_address":{"type":["string","null"],"description":"Adresse"},"cp":{"type":["string","number","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"email":{"type":["string","null"],"format":"email","description":"Email"},"origin":{"type":["object","null"],"properties":{"color":{"type":["string","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"manager":{"type":["string","null"],"description":"Commercial"},"agency":{"type":["string","null"],"description":"Agence"},"source":{"type":["string","null"],"description":"Origine du contact"},"is_prospect":{"type":["boolean","null"],"description":"Is prospect"},"person":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"civility_id":{"type":["integer","string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Nom"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"comment":{"type":["string","null"],"description":"Précisions"},"email":{"type":["string","null"],"format":"email","description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"fax":{"type":["string","null"],"description":"Fax"},"function":{"type":["string","null"],"description":"Statut"},"identity":{"type":["string","null"],"description":"Identity"},"web":{"type":["string","null"],"description":"Site Web"},"is_quote_recipient":{"type":["boolean","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["boolean","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["boolean","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["boolean","null"],"description":"Is delivery recipient"},"service":{"type":["string","null"],"description":"Service"},"civility":{"type":["string","null"],"description":"Civilité"},"contact":{"type":["string","null"],"description":"Tiers"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"agency":{"type":"null","description":"Agence"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"contact_type":{"oneOf":[{"type":"object"},{"type":"string"}]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"address":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"lat":{"type":["string","number","null"],"description":"Latitude"},"lng":{"type":["string","number","null"],"description":"Longitude"},"country_id":{"type":["integer","string","null"],"description":"Pays"},"cp":{"type":["string","number","null"],"description":"Code postal"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"model_type":{"type":["string","null"],"description":"Model type"},"city":{"type":["string","null"],"description":"Ville"},"full_address":{"type":["string","null"],"description":"Adresse"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"country":{"type":["string","null"],"description":"Pays"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"contact":{"type":["string","null"],"description":"Tiers"},"is_main":{"type":["boolean","null"],"description":"Is main"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"country_id":{"type":["integer","string","null"],"description":"Pays"},"country":{"type":["string","null"],"description":"Pays"},"representation":{"type":["string","null"],"description":"Nom"},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"account_number_fmt":{"type":["string","null"],"description":"Numéro de compte"},"unpaid_total_solde":{"type":["integer","null"],"description":"Total non payé (T.T.C)"},"comment":{"type":["string","null"],"description":"Précisions"},"logo_url":{"type":"null","description":"Logo url"},"logo_thumb_url":{"type":"null","description":"Logo thumb url"},"type":{"type":["string","null"],"description":"Type"},"project_id":{"type":["integer","string","null"],"description":"Project id"},"person_morale":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"legal_form_id":{"type":["integer","string","null"],"description":"Forme juridique"},"rcs":{"type":["null","string"]},"tva_intra":{"type":["string","null"],"description":"N° TVA Intracommunautaire"},"naf":{"type":["string","null"],"description":"Activité"},"code_naf":{"type":["string","null"],"description":"Code Activité"},"legal_name":{"type":["string","null"],"description":"Nom juridique"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"foundation":{"type":["string","null"],"format":"date","description":"Date de création"},"siret":{"type":["string","number","null"],"description":"Siret"},"ape":{"type":["string","null"],"description":"APE"},"capital":{"type":["null","number"]},"ca":{"type":["null","number"]},"effectif":{"type":["null","number"]},"tva":{"type":["null","string"]},"autoliquidation_tva":{"type":["null","boolean"]},"siren":{"type":["null","string"]},"chorus_pro":{"type":["boolean","null"],"description":"Chorus Pro"},"legal_form":{"type":["string","null"],"description":"Forme juridique"},"tva_enabled":{"type":["boolean","null"],"description":"Utiliser la TVA"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"condition":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"payment_mode_id":{"type":["integer","string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["integer","string","null"],"description":"Type de règlement"},"billing_type_id":{"type":["integer","string","null"],"description":"Type de facturation"},"discount":{"type":["string","number","null"],"description":"Taux de remise"},"code_compta":{"type":["null","string"]},"banque":{"type":["null","string"]},"iban":{"type":["null","string"]},"bic":{"type":["null","string"]},"delivery_time":{"type":["null","number"]},"group_subscription_invoices":{"type":["boolean","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["boolean","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["null","string"]},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"billing_type":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["null","number"]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"notes":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true},"contact_prospect_params":{"type":"object","properties":{"prospect":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"logo":{"type":["string","null"],"description":"Logo"},"origin_id":{"type":["integer","null"],"description":"Type de tiers"},"source_id":{"type":["integer","null"],"description":"Origine du contact"},"sector_id":{"type":["integer","null"],"description":"Secteur d'activité"},"code":{"type":["string","null"],"description":"Code Client"},"comment":{"type":["string","null"],"description":"Précisions"},"account_number":{"type":["string","null"],"description":"Numéro de compte"},"manager_id":{"type":["integer","null"],"description":"Commercial"},"agency_id":{"type":["integer","null"],"description":"Agence"},"internal":{"type":["boolean","null"],"description":"Interne"},"person_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"ID"},"civility_id":{"type":["string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Entreprise"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"secondname":{"type":["string","null"],"description":"Seconds Prénoms"},"function":{"type":["string","null"],"description":"Statut"},"email":{"type":["string","null"],"description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"fax":{"type":["string","null"],"description":"Fax"},"portable":{"type":["string","null"],"description":"Mobile"},"web":{"type":["string","null"],"description":"Site Web"},"comment":{"type":["string","null"],"description":"Précisions"},"is_quote_recipient":{"type":["string","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["string","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["string","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["string","null"],"description":"Is delivery recipient"},"origin_id":{"type":["string","null"],"description":"Origin id"}}},"person_morale_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Id"},"name":{"type":["string","null"],"description":"Name"},"trade_name":{"type":["string","null"],"description":"Trade name"},"legal_name":{"type":["string","null"],"description":"Legal name"},"legal_form_id":{"type":["string","null"],"description":"Legal form id"},"rcs":{"type":["string","null"],"description":"Rcs"},"tva_intra":{"type":["string","null"],"description":"Tva intra"},"naf":{"type":["string","null"],"description":"Naf"},"code_naf":{"type":["string","null"],"description":"Code naf"},"chorus_pro":{"type":["string","null"],"description":"Chorus pro"},"siret":{"type":["string","null"],"description":"Siret"},"siren":{"type":["string","null"],"description":"Siren"},"foundation":{"type":["string","null"],"description":"Foundation"},"ape":{"type":["string","null"],"description":"Ape"},"capital":{"type":["string","null"],"description":"Capital"},"ca":{"type":["string","null"],"description":"Ca"},"effectif":{"type":["string","null"],"description":"Effectif"},"tva":{"type":["string","null"],"description":"Tva"},"autoliquidation_tva":{"type":["string","null"],"description":"Autoliquidation tva"},"comment":{"type":["string","null"],"description":"Comment"},"origin_id":{"type":["string","null"],"description":"Origin id"},"tva_enabled":{"type":["string","null"],"description":"Tva enabled"}}},"condition_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"ID"},"payment_mode_id":{"type":["string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["string","null"],"description":"Type d'échéance"},"discount":{"type":["string","null"],"description":"Taux de remise"},"code_compta":{"type":["string","null"],"description":"Code Comptabilité"},"banque":{"type":["string","null"],"description":"Banque"},"iban":{"type":["string","null"],"description":"IBAN"},"bic":{"type":["string","null"],"description":"BIC"},"billing_type_id":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["string","null"],"description":"Nombre de factures à imprimer"},"delivery_time":{"type":["string","null"],"description":"Temps de livraison (jours)"},"group_subscription_invoices":{"type":["string","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["string","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["string","null"],"description":"RUM"},"accounting_journal_id":{"type":["string","null"],"description":"Journal de Banque"}}},"address_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"ID"},"name":{"type":["string","null"],"description":"Nom de l'adresse"},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"cp":{"type":["string","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"lat":{"type":["string","null"],"description":"Latitude"},"lng":{"type":["string","null"],"description":"Longitude"},"country_id":{"type":["string","null"],"description":"Pays"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"trade_name":{"type":["string","null"],"description":"Nom complémentaire"},"model_id":{"type":["string","null"],"description":"Model id"},"model_type":{"type":["string","null"],"description":"Model type"}}}},"required":[]}},"required":["prospect"]}}},"paths":{"/prospects":{"post":{"summary":"Create prospect","tags":["Contact - Prospects"],"description":"Create a new Contact prospect. Prospect","parameters":[],"responses":{"200":{"description":"Created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_detail"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_params"}}}}}}}}
```

## New prospect form data

> Get form data for creating new prospect

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"contact_prospect_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Date de création"},"updated_at":{"type":["string","null"],"description":"Date de modification"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"code":{"type":["string","null"],"description":"Code Client"},"origin_id":{"type":["integer","string","null"],"description":"Type de tiers"},"source_id":{"type":["integer","string","null"],"description":"Origine du contact"},"person_id":{"type":["integer","string","null"],"description":"Person id"},"address_id":{"type":["integer","string","null"],"description":"Address id"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"manager_id":{"type":["integer","string","null"],"description":"Commercial"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"account_number":{"type":["null","string"]},"internal":{"type":["null","boolean"]},"_address":{"type":["string","null"],"description":"Adresse"},"cp":{"type":["string","number","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"email":{"type":["string","null"],"format":"email","description":"Email"},"origin":{"type":["object","null"],"properties":{"color":{"type":["string","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"manager":{"type":["string","null"],"description":"Commercial"},"agency":{"type":["string","null"],"description":"Agence"},"source":{"type":["string","null"],"description":"Origine du contact"},"is_prospect":{"type":["boolean","null"],"description":"Is prospect"},"person":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"civility_id":{"type":["integer","string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Nom"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"comment":{"type":["string","null"],"description":"Précisions"},"email":{"type":["string","null"],"format":"email","description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"fax":{"type":["string","null"],"description":"Fax"},"function":{"type":["string","null"],"description":"Statut"},"identity":{"type":["string","null"],"description":"Identity"},"web":{"type":["string","null"],"description":"Site Web"},"is_quote_recipient":{"type":["boolean","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["boolean","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["boolean","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["boolean","null"],"description":"Is delivery recipient"},"service":{"type":["string","null"],"description":"Service"},"civility":{"type":["string","null"],"description":"Civilité"},"contact":{"type":["string","null"],"description":"Tiers"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"agency":{"type":"null","description":"Agence"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"contact_type":{"oneOf":[{"type":"object"},{"type":"string"}]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"address":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"lat":{"type":["string","number","null"],"description":"Latitude"},"lng":{"type":["string","number","null"],"description":"Longitude"},"country_id":{"type":["integer","string","null"],"description":"Pays"},"cp":{"type":["string","number","null"],"description":"Code postal"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"model_type":{"type":["string","null"],"description":"Model type"},"city":{"type":["string","null"],"description":"Ville"},"full_address":{"type":["string","null"],"description":"Adresse"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"country":{"type":["string","null"],"description":"Pays"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"contact":{"type":["string","null"],"description":"Tiers"},"is_main":{"type":["boolean","null"],"description":"Is main"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"country_id":{"type":["integer","string","null"],"description":"Pays"},"country":{"type":["string","null"],"description":"Pays"},"representation":{"type":["string","null"],"description":"Nom"},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"account_number_fmt":{"type":["string","null"],"description":"Numéro de compte"},"unpaid_total_solde":{"type":["integer","null"],"description":"Total non payé (T.T.C)"},"comment":{"type":["string","null"],"description":"Précisions"},"logo_url":{"type":"null","description":"Logo url"},"logo_thumb_url":{"type":"null","description":"Logo thumb url"},"type":{"type":["string","null"],"description":"Type"},"project_id":{"type":["integer","string","null"],"description":"Project id"},"person_morale":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"legal_form_id":{"type":["integer","string","null"],"description":"Forme juridique"},"rcs":{"type":["null","string"]},"tva_intra":{"type":["string","null"],"description":"N° TVA Intracommunautaire"},"naf":{"type":["string","null"],"description":"Activité"},"code_naf":{"type":["string","null"],"description":"Code Activité"},"legal_name":{"type":["string","null"],"description":"Nom juridique"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"foundation":{"type":["string","null"],"format":"date","description":"Date de création"},"siret":{"type":["string","number","null"],"description":"Siret"},"ape":{"type":["string","null"],"description":"APE"},"capital":{"type":["null","number"]},"ca":{"type":["null","number"]},"effectif":{"type":["null","number"]},"tva":{"type":["null","string"]},"autoliquidation_tva":{"type":["null","boolean"]},"siren":{"type":["null","string"]},"chorus_pro":{"type":["boolean","null"],"description":"Chorus Pro"},"legal_form":{"type":["string","null"],"description":"Forme juridique"},"tva_enabled":{"type":["boolean","null"],"description":"Utiliser la TVA"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"condition":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"payment_mode_id":{"type":["integer","string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["integer","string","null"],"description":"Type de règlement"},"billing_type_id":{"type":["integer","string","null"],"description":"Type de facturation"},"discount":{"type":["string","number","null"],"description":"Taux de remise"},"code_compta":{"type":["null","string"]},"banque":{"type":["null","string"]},"iban":{"type":["null","string"]},"bic":{"type":["null","string"]},"delivery_time":{"type":["null","number"]},"group_subscription_invoices":{"type":["boolean","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["boolean","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["null","string"]},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"billing_type":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["null","number"]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"notes":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/prospects/new":{"get":{"summary":"New prospect form data","tags":["Contact - Prospects"],"description":"Get form data for creating new prospect","responses":{"200":{"description":"Form data retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_detail"}}}}}}}}}
```

## Show prospect

> Get a specific prospect by ID

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"contact_prospect_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Date de création"},"updated_at":{"type":["string","null"],"description":"Date de modification"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"code":{"type":["string","null"],"description":"Code Client"},"origin_id":{"type":["integer","string","null"],"description":"Type de tiers"},"source_id":{"type":["integer","string","null"],"description":"Origine du contact"},"person_id":{"type":["integer","string","null"],"description":"Person id"},"address_id":{"type":["integer","string","null"],"description":"Address id"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"manager_id":{"type":["integer","string","null"],"description":"Commercial"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"account_number":{"type":["null","string"]},"internal":{"type":["null","boolean"]},"_address":{"type":["string","null"],"description":"Adresse"},"cp":{"type":["string","number","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"email":{"type":["string","null"],"format":"email","description":"Email"},"origin":{"type":["object","null"],"properties":{"color":{"type":["string","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"manager":{"type":["string","null"],"description":"Commercial"},"agency":{"type":["string","null"],"description":"Agence"},"source":{"type":["string","null"],"description":"Origine du contact"},"is_prospect":{"type":["boolean","null"],"description":"Is prospect"},"person":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"civility_id":{"type":["integer","string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Nom"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"comment":{"type":["string","null"],"description":"Précisions"},"email":{"type":["string","null"],"format":"email","description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"fax":{"type":["string","null"],"description":"Fax"},"function":{"type":["string","null"],"description":"Statut"},"identity":{"type":["string","null"],"description":"Identity"},"web":{"type":["string","null"],"description":"Site Web"},"is_quote_recipient":{"type":["boolean","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["boolean","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["boolean","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["boolean","null"],"description":"Is delivery recipient"},"service":{"type":["string","null"],"description":"Service"},"civility":{"type":["string","null"],"description":"Civilité"},"contact":{"type":["string","null"],"description":"Tiers"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"agency":{"type":"null","description":"Agence"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"contact_type":{"oneOf":[{"type":"object"},{"type":"string"}]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"address":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"lat":{"type":["string","number","null"],"description":"Latitude"},"lng":{"type":["string","number","null"],"description":"Longitude"},"country_id":{"type":["integer","string","null"],"description":"Pays"},"cp":{"type":["string","number","null"],"description":"Code postal"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"model_type":{"type":["string","null"],"description":"Model type"},"city":{"type":["string","null"],"description":"Ville"},"full_address":{"type":["string","null"],"description":"Adresse"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"country":{"type":["string","null"],"description":"Pays"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"contact":{"type":["string","null"],"description":"Tiers"},"is_main":{"type":["boolean","null"],"description":"Is main"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"country_id":{"type":["integer","string","null"],"description":"Pays"},"country":{"type":["string","null"],"description":"Pays"},"representation":{"type":["string","null"],"description":"Nom"},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"account_number_fmt":{"type":["string","null"],"description":"Numéro de compte"},"unpaid_total_solde":{"type":["integer","null"],"description":"Total non payé (T.T.C)"},"comment":{"type":["string","null"],"description":"Précisions"},"logo_url":{"type":"null","description":"Logo url"},"logo_thumb_url":{"type":"null","description":"Logo thumb url"},"type":{"type":["string","null"],"description":"Type"},"project_id":{"type":["integer","string","null"],"description":"Project id"},"person_morale":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"legal_form_id":{"type":["integer","string","null"],"description":"Forme juridique"},"rcs":{"type":["null","string"]},"tva_intra":{"type":["string","null"],"description":"N° TVA Intracommunautaire"},"naf":{"type":["string","null"],"description":"Activité"},"code_naf":{"type":["string","null"],"description":"Code Activité"},"legal_name":{"type":["string","null"],"description":"Nom juridique"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"foundation":{"type":["string","null"],"format":"date","description":"Date de création"},"siret":{"type":["string","number","null"],"description":"Siret"},"ape":{"type":["string","null"],"description":"APE"},"capital":{"type":["null","number"]},"ca":{"type":["null","number"]},"effectif":{"type":["null","number"]},"tva":{"type":["null","string"]},"autoliquidation_tva":{"type":["null","boolean"]},"siren":{"type":["null","string"]},"chorus_pro":{"type":["boolean","null"],"description":"Chorus Pro"},"legal_form":{"type":["string","null"],"description":"Forme juridique"},"tva_enabled":{"type":["boolean","null"],"description":"Utiliser la TVA"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"condition":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"payment_mode_id":{"type":["integer","string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["integer","string","null"],"description":"Type de règlement"},"billing_type_id":{"type":["integer","string","null"],"description":"Type de facturation"},"discount":{"type":["string","number","null"],"description":"Taux de remise"},"code_compta":{"type":["null","string"]},"banque":{"type":["null","string"]},"iban":{"type":["null","string"]},"bic":{"type":["null","string"]},"delivery_time":{"type":["null","number"]},"group_subscription_invoices":{"type":["boolean","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["boolean","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["null","string"]},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"billing_type":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["null","number"]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"notes":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/prospects/{id}":{"get":{"summary":"Show prospect","tags":["Contact - Prospects"],"description":"Get a specific prospect by ID","responses":{"200":{"description":"Prospect details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_detail"}}}},"404":{"description":"Prospect not found"}}}}}}
```

## Delete prospect

> Delete a prospect (soft delete)

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"delete_response":{"type":"object","properties":{}}}},"paths":{"/prospects/{id}":{"delete":{"summary":"Delete prospect","tags":["Contact - Prospects"],"description":"Delete a prospect (soft delete)","responses":{"200":{"description":"Deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_response"}}}}}}}}}
```

## Update prospect

> Update an existing prospect

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"contact_prospect_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Date de création"},"updated_at":{"type":["string","null"],"description":"Date de modification"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"code":{"type":["string","null"],"description":"Code Client"},"origin_id":{"type":["integer","string","null"],"description":"Type de tiers"},"source_id":{"type":["integer","string","null"],"description":"Origine du contact"},"person_id":{"type":["integer","string","null"],"description":"Person id"},"address_id":{"type":["integer","string","null"],"description":"Address id"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"manager_id":{"type":["integer","string","null"],"description":"Commercial"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"account_number":{"type":["null","string"]},"internal":{"type":["null","boolean"]},"_address":{"type":["string","null"],"description":"Adresse"},"cp":{"type":["string","number","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"email":{"type":["string","null"],"format":"email","description":"Email"},"origin":{"type":["object","null"],"properties":{"color":{"type":["string","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"manager":{"type":["string","null"],"description":"Commercial"},"agency":{"type":["string","null"],"description":"Agence"},"source":{"type":["string","null"],"description":"Origine du contact"},"is_prospect":{"type":["boolean","null"],"description":"Is prospect"},"person":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"civility_id":{"type":["integer","string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Nom"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"comment":{"type":["string","null"],"description":"Précisions"},"email":{"type":["string","null"],"format":"email","description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"fax":{"type":["string","null"],"description":"Fax"},"function":{"type":["string","null"],"description":"Statut"},"identity":{"type":["string","null"],"description":"Identity"},"web":{"type":["string","null"],"description":"Site Web"},"is_quote_recipient":{"type":["boolean","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["boolean","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["boolean","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["boolean","null"],"description":"Is delivery recipient"},"service":{"type":["string","null"],"description":"Service"},"civility":{"type":["string","null"],"description":"Civilité"},"contact":{"type":["string","null"],"description":"Tiers"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"agency":{"type":"null","description":"Agence"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"contact_type":{"oneOf":[{"type":"object"},{"type":"string"}]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"address":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"lat":{"type":["string","number","null"],"description":"Latitude"},"lng":{"type":["string","number","null"],"description":"Longitude"},"country_id":{"type":["integer","string","null"],"description":"Pays"},"cp":{"type":["string","number","null"],"description":"Code postal"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"model_type":{"type":["string","null"],"description":"Model type"},"city":{"type":["string","null"],"description":"Ville"},"full_address":{"type":["string","null"],"description":"Adresse"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"country":{"type":["string","null"],"description":"Pays"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"contact":{"type":["string","null"],"description":"Tiers"},"is_main":{"type":["boolean","null"],"description":"Is main"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"country_id":{"type":["integer","string","null"],"description":"Pays"},"country":{"type":["string","null"],"description":"Pays"},"representation":{"type":["string","null"],"description":"Nom"},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"account_number_fmt":{"type":["string","null"],"description":"Numéro de compte"},"unpaid_total_solde":{"type":["integer","null"],"description":"Total non payé (T.T.C)"},"comment":{"type":["string","null"],"description":"Précisions"},"logo_url":{"type":"null","description":"Logo url"},"logo_thumb_url":{"type":"null","description":"Logo thumb url"},"type":{"type":["string","null"],"description":"Type"},"project_id":{"type":["integer","string","null"],"description":"Project id"},"person_morale":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"legal_form_id":{"type":["integer","string","null"],"description":"Forme juridique"},"rcs":{"type":["null","string"]},"tva_intra":{"type":["string","null"],"description":"N° TVA Intracommunautaire"},"naf":{"type":["string","null"],"description":"Activité"},"code_naf":{"type":["string","null"],"description":"Code Activité"},"legal_name":{"type":["string","null"],"description":"Nom juridique"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"foundation":{"type":["string","null"],"format":"date","description":"Date de création"},"siret":{"type":["string","number","null"],"description":"Siret"},"ape":{"type":["string","null"],"description":"APE"},"capital":{"type":["null","number"]},"ca":{"type":["null","number"]},"effectif":{"type":["null","number"]},"tva":{"type":["null","string"]},"autoliquidation_tva":{"type":["null","boolean"]},"siren":{"type":["null","string"]},"chorus_pro":{"type":["boolean","null"],"description":"Chorus Pro"},"legal_form":{"type":["string","null"],"description":"Forme juridique"},"tva_enabled":{"type":["boolean","null"],"description":"Utiliser la TVA"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"condition":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"payment_mode_id":{"type":["integer","string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["integer","string","null"],"description":"Type de règlement"},"billing_type_id":{"type":["integer","string","null"],"description":"Type de facturation"},"discount":{"type":["string","number","null"],"description":"Taux de remise"},"code_compta":{"type":["null","string"]},"banque":{"type":["null","string"]},"iban":{"type":["null","string"]},"bic":{"type":["null","string"]},"delivery_time":{"type":["null","number"]},"group_subscription_invoices":{"type":["boolean","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["boolean","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["null","string"]},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"billing_type":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["null","number"]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"notes":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true},"contact_prospect_params":{"type":"object","properties":{"prospect":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"logo":{"type":["string","null"],"description":"Logo"},"origin_id":{"type":["integer","null"],"description":"Type de tiers"},"source_id":{"type":["integer","null"],"description":"Origine du contact"},"sector_id":{"type":["integer","null"],"description":"Secteur d'activité"},"code":{"type":["string","null"],"description":"Code Client"},"comment":{"type":["string","null"],"description":"Précisions"},"account_number":{"type":["string","null"],"description":"Numéro de compte"},"manager_id":{"type":["integer","null"],"description":"Commercial"},"agency_id":{"type":["integer","null"],"description":"Agence"},"internal":{"type":["boolean","null"],"description":"Interne"},"person_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"ID"},"civility_id":{"type":["string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Entreprise"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"secondname":{"type":["string","null"],"description":"Seconds Prénoms"},"function":{"type":["string","null"],"description":"Statut"},"email":{"type":["string","null"],"description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"fax":{"type":["string","null"],"description":"Fax"},"portable":{"type":["string","null"],"description":"Mobile"},"web":{"type":["string","null"],"description":"Site Web"},"comment":{"type":["string","null"],"description":"Précisions"},"is_quote_recipient":{"type":["string","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["string","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["string","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["string","null"],"description":"Is delivery recipient"},"origin_id":{"type":["string","null"],"description":"Origin id"}}},"person_morale_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Id"},"name":{"type":["string","null"],"description":"Name"},"trade_name":{"type":["string","null"],"description":"Trade name"},"legal_name":{"type":["string","null"],"description":"Legal name"},"legal_form_id":{"type":["string","null"],"description":"Legal form id"},"rcs":{"type":["string","null"],"description":"Rcs"},"tva_intra":{"type":["string","null"],"description":"Tva intra"},"naf":{"type":["string","null"],"description":"Naf"},"code_naf":{"type":["string","null"],"description":"Code naf"},"chorus_pro":{"type":["string","null"],"description":"Chorus pro"},"siret":{"type":["string","null"],"description":"Siret"},"siren":{"type":["string","null"],"description":"Siren"},"foundation":{"type":["string","null"],"description":"Foundation"},"ape":{"type":["string","null"],"description":"Ape"},"capital":{"type":["string","null"],"description":"Capital"},"ca":{"type":["string","null"],"description":"Ca"},"effectif":{"type":["string","null"],"description":"Effectif"},"tva":{"type":["string","null"],"description":"Tva"},"autoliquidation_tva":{"type":["string","null"],"description":"Autoliquidation tva"},"comment":{"type":["string","null"],"description":"Comment"},"origin_id":{"type":["string","null"],"description":"Origin id"},"tva_enabled":{"type":["string","null"],"description":"Tva enabled"}}},"condition_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"ID"},"payment_mode_id":{"type":["string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["string","null"],"description":"Type d'échéance"},"discount":{"type":["string","null"],"description":"Taux de remise"},"code_compta":{"type":["string","null"],"description":"Code Comptabilité"},"banque":{"type":["string","null"],"description":"Banque"},"iban":{"type":["string","null"],"description":"IBAN"},"bic":{"type":["string","null"],"description":"BIC"},"billing_type_id":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["string","null"],"description":"Nombre de factures à imprimer"},"delivery_time":{"type":["string","null"],"description":"Temps de livraison (jours)"},"group_subscription_invoices":{"type":["string","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["string","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["string","null"],"description":"RUM"},"accounting_journal_id":{"type":["string","null"],"description":"Journal de Banque"}}},"address_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"ID"},"name":{"type":["string","null"],"description":"Nom de l'adresse"},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"cp":{"type":["string","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"lat":{"type":["string","null"],"description":"Latitude"},"lng":{"type":["string","null"],"description":"Longitude"},"country_id":{"type":["string","null"],"description":"Pays"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"trade_name":{"type":["string","null"],"description":"Nom complémentaire"},"model_id":{"type":["string","null"],"description":"Model id"},"model_type":{"type":["string","null"],"description":"Model type"}}}},"required":[]}},"required":["prospect"]}}},"paths":{"/prospects/{id}":{"patch":{"summary":"Update prospect","tags":["Contact - Prospects"],"description":"Update an existing prospect","parameters":[],"responses":{"200":{"description":"Updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_detail"}}}},"404":{"description":"Prospect not found"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_params"}}}}}}}}
```

## POST /prospects/{id}/active

> Mark prospect as active

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"contact_prospect_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Date de création"},"updated_at":{"type":["string","null"],"description":"Date de modification"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"code":{"type":["string","null"],"description":"Code Client"},"origin_id":{"type":["integer","string","null"],"description":"Type de tiers"},"source_id":{"type":["integer","string","null"],"description":"Origine du contact"},"person_id":{"type":["integer","string","null"],"description":"Person id"},"address_id":{"type":["integer","string","null"],"description":"Address id"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"manager_id":{"type":["integer","string","null"],"description":"Commercial"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"account_number":{"type":["null","string"]},"internal":{"type":["null","boolean"]},"_address":{"type":["string","null"],"description":"Adresse"},"cp":{"type":["string","number","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"email":{"type":["string","null"],"format":"email","description":"Email"},"origin":{"type":["object","null"],"properties":{"color":{"type":["string","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"manager":{"type":["string","null"],"description":"Commercial"},"agency":{"type":["string","null"],"description":"Agence"},"source":{"type":["string","null"],"description":"Origine du contact"},"is_prospect":{"type":["boolean","null"],"description":"Is prospect"},"person":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"civility_id":{"type":["integer","string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Nom"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"comment":{"type":["string","null"],"description":"Précisions"},"email":{"type":["string","null"],"format":"email","description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"fax":{"type":["string","null"],"description":"Fax"},"function":{"type":["string","null"],"description":"Statut"},"identity":{"type":["string","null"],"description":"Identity"},"web":{"type":["string","null"],"description":"Site Web"},"is_quote_recipient":{"type":["boolean","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["boolean","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["boolean","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["boolean","null"],"description":"Is delivery recipient"},"service":{"type":["string","null"],"description":"Service"},"civility":{"type":["string","null"],"description":"Civilité"},"contact":{"type":["string","null"],"description":"Tiers"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"agency":{"type":"null","description":"Agence"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"contact_type":{"oneOf":[{"type":"object"},{"type":"string"}]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"address":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"lat":{"type":["string","number","null"],"description":"Latitude"},"lng":{"type":["string","number","null"],"description":"Longitude"},"country_id":{"type":["integer","string","null"],"description":"Pays"},"cp":{"type":["string","number","null"],"description":"Code postal"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"model_type":{"type":["string","null"],"description":"Model type"},"city":{"type":["string","null"],"description":"Ville"},"full_address":{"type":["string","null"],"description":"Adresse"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"country":{"type":["string","null"],"description":"Pays"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"contact":{"type":["string","null"],"description":"Tiers"},"is_main":{"type":["boolean","null"],"description":"Is main"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"country_id":{"type":["integer","string","null"],"description":"Pays"},"country":{"type":["string","null"],"description":"Pays"},"representation":{"type":["string","null"],"description":"Nom"},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"account_number_fmt":{"type":["string","null"],"description":"Numéro de compte"},"unpaid_total_solde":{"type":["integer","null"],"description":"Total non payé (T.T.C)"},"comment":{"type":["string","null"],"description":"Précisions"},"logo_url":{"type":"null","description":"Logo url"},"logo_thumb_url":{"type":"null","description":"Logo thumb url"},"type":{"type":["string","null"],"description":"Type"},"project_id":{"type":["integer","string","null"],"description":"Project id"},"person_morale":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"legal_form_id":{"type":["integer","string","null"],"description":"Forme juridique"},"rcs":{"type":["null","string"]},"tva_intra":{"type":["string","null"],"description":"N° TVA Intracommunautaire"},"naf":{"type":["string","null"],"description":"Activité"},"code_naf":{"type":["string","null"],"description":"Code Activité"},"legal_name":{"type":["string","null"],"description":"Nom juridique"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"foundation":{"type":["string","null"],"format":"date","description":"Date de création"},"siret":{"type":["string","number","null"],"description":"Siret"},"ape":{"type":["string","null"],"description":"APE"},"capital":{"type":["null","number"]},"ca":{"type":["null","number"]},"effectif":{"type":["null","number"]},"tva":{"type":["null","string"]},"autoliquidation_tva":{"type":["null","boolean"]},"siren":{"type":["null","string"]},"chorus_pro":{"type":["boolean","null"],"description":"Chorus Pro"},"legal_form":{"type":["string","null"],"description":"Forme juridique"},"tva_enabled":{"type":["boolean","null"],"description":"Utiliser la TVA"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"condition":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"payment_mode_id":{"type":["integer","string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["integer","string","null"],"description":"Type de règlement"},"billing_type_id":{"type":["integer","string","null"],"description":"Type de facturation"},"discount":{"type":["string","number","null"],"description":"Taux de remise"},"code_compta":{"type":["null","string"]},"banque":{"type":["null","string"]},"iban":{"type":["null","string"]},"bic":{"type":["null","string"]},"delivery_time":{"type":["null","number"]},"group_subscription_invoices":{"type":["boolean","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["boolean","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["null","string"]},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"billing_type":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["null","number"]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"notes":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/prospects/{id}/active":{"post":{"summary":"Mark prospect as active","tags":["Contact - Prospects"],"responses":{"200":{"description":"Marked as active","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_detail"}}}}}}}}}
```

## POST /prospects/{id}/inactive

> Mark prospect as inactive

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"contact_prospect_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Date de création"},"updated_at":{"type":["string","null"],"description":"Date de modification"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"code":{"type":["string","null"],"description":"Code Client"},"origin_id":{"type":["integer","string","null"],"description":"Type de tiers"},"source_id":{"type":["integer","string","null"],"description":"Origine du contact"},"person_id":{"type":["integer","string","null"],"description":"Person id"},"address_id":{"type":["integer","string","null"],"description":"Address id"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"manager_id":{"type":["integer","string","null"],"description":"Commercial"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"account_number":{"type":["null","string"]},"internal":{"type":["null","boolean"]},"_address":{"type":["string","null"],"description":"Adresse"},"cp":{"type":["string","number","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"email":{"type":["string","null"],"format":"email","description":"Email"},"origin":{"type":["object","null"],"properties":{"color":{"type":["string","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"manager":{"type":["string","null"],"description":"Commercial"},"agency":{"type":["string","null"],"description":"Agence"},"source":{"type":["string","null"],"description":"Origine du contact"},"is_prospect":{"type":["boolean","null"],"description":"Is prospect"},"person":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"civility_id":{"type":["integer","string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Nom"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"comment":{"type":["string","null"],"description":"Précisions"},"email":{"type":["string","null"],"format":"email","description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"fax":{"type":["string","null"],"description":"Fax"},"function":{"type":["string","null"],"description":"Statut"},"identity":{"type":["string","null"],"description":"Identity"},"web":{"type":["string","null"],"description":"Site Web"},"is_quote_recipient":{"type":["boolean","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["boolean","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["boolean","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["boolean","null"],"description":"Is delivery recipient"},"service":{"type":["string","null"],"description":"Service"},"civility":{"type":["string","null"],"description":"Civilité"},"contact":{"type":["string","null"],"description":"Tiers"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"agency":{"type":"null","description":"Agence"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"contact_type":{"oneOf":[{"type":"object"},{"type":"string"}]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"address":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"lat":{"type":["string","number","null"],"description":"Latitude"},"lng":{"type":["string","number","null"],"description":"Longitude"},"country_id":{"type":["integer","string","null"],"description":"Pays"},"cp":{"type":["string","number","null"],"description":"Code postal"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"model_type":{"type":["string","null"],"description":"Model type"},"city":{"type":["string","null"],"description":"Ville"},"full_address":{"type":["string","null"],"description":"Adresse"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"country":{"type":["string","null"],"description":"Pays"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"contact":{"type":["string","null"],"description":"Tiers"},"is_main":{"type":["boolean","null"],"description":"Is main"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"country_id":{"type":["integer","string","null"],"description":"Pays"},"country":{"type":["string","null"],"description":"Pays"},"representation":{"type":["string","null"],"description":"Nom"},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"account_number_fmt":{"type":["string","null"],"description":"Numéro de compte"},"unpaid_total_solde":{"type":["integer","null"],"description":"Total non payé (T.T.C)"},"comment":{"type":["string","null"],"description":"Précisions"},"logo_url":{"type":"null","description":"Logo url"},"logo_thumb_url":{"type":"null","description":"Logo thumb url"},"type":{"type":["string","null"],"description":"Type"},"project_id":{"type":["integer","string","null"],"description":"Project id"},"person_morale":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"legal_form_id":{"type":["integer","string","null"],"description":"Forme juridique"},"rcs":{"type":["null","string"]},"tva_intra":{"type":["string","null"],"description":"N° TVA Intracommunautaire"},"naf":{"type":["string","null"],"description":"Activité"},"code_naf":{"type":["string","null"],"description":"Code Activité"},"legal_name":{"type":["string","null"],"description":"Nom juridique"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"foundation":{"type":["string","null"],"format":"date","description":"Date de création"},"siret":{"type":["string","number","null"],"description":"Siret"},"ape":{"type":["string","null"],"description":"APE"},"capital":{"type":["null","number"]},"ca":{"type":["null","number"]},"effectif":{"type":["null","number"]},"tva":{"type":["null","string"]},"autoliquidation_tva":{"type":["null","boolean"]},"siren":{"type":["null","string"]},"chorus_pro":{"type":["boolean","null"],"description":"Chorus Pro"},"legal_form":{"type":["string","null"],"description":"Forme juridique"},"tva_enabled":{"type":["boolean","null"],"description":"Utiliser la TVA"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"condition":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"payment_mode_id":{"type":["integer","string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["integer","string","null"],"description":"Type de règlement"},"billing_type_id":{"type":["integer","string","null"],"description":"Type de facturation"},"discount":{"type":["string","number","null"],"description":"Taux de remise"},"code_compta":{"type":["null","string"]},"banque":{"type":["null","string"]},"iban":{"type":["null","string"]},"bic":{"type":["null","string"]},"delivery_time":{"type":["null","number"]},"group_subscription_invoices":{"type":["boolean","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["boolean","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["null","string"]},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"billing_type":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["null","number"]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"notes":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/prospects/{id}/inactive":{"post":{"summary":"Mark prospect as inactive","tags":["Contact - Prospects"],"responses":{"200":{"description":"Marked as inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_detail"}}}}}}}}}
```

## POST /prospects/{id}/undelete

> Undelete prospect

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"contact_prospect_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Date de création"},"updated_at":{"type":["string","null"],"description":"Date de modification"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"code":{"type":["string","null"],"description":"Code Client"},"origin_id":{"type":["integer","string","null"],"description":"Type de tiers"},"source_id":{"type":["integer","string","null"],"description":"Origine du contact"},"person_id":{"type":["integer","string","null"],"description":"Person id"},"address_id":{"type":["integer","string","null"],"description":"Address id"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"manager_id":{"type":["integer","string","null"],"description":"Commercial"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"account_number":{"type":["null","string"]},"internal":{"type":["null","boolean"]},"_address":{"type":["string","null"],"description":"Adresse"},"cp":{"type":["string","number","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"email":{"type":["string","null"],"format":"email","description":"Email"},"origin":{"type":["object","null"],"properties":{"color":{"type":["string","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"manager":{"type":["string","null"],"description":"Commercial"},"agency":{"type":["string","null"],"description":"Agence"},"source":{"type":["string","null"],"description":"Origine du contact"},"is_prospect":{"type":["boolean","null"],"description":"Is prospect"},"person":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"civility_id":{"type":["integer","string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Nom"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"comment":{"type":["string","null"],"description":"Précisions"},"email":{"type":["string","null"],"format":"email","description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"fax":{"type":["string","null"],"description":"Fax"},"function":{"type":["string","null"],"description":"Statut"},"identity":{"type":["string","null"],"description":"Identity"},"web":{"type":["string","null"],"description":"Site Web"},"is_quote_recipient":{"type":["boolean","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["boolean","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["boolean","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["boolean","null"],"description":"Is delivery recipient"},"service":{"type":["string","null"],"description":"Service"},"civility":{"type":["string","null"],"description":"Civilité"},"contact":{"type":["string","null"],"description":"Tiers"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"agency":{"type":"null","description":"Agence"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"contact_type":{"oneOf":[{"type":"object"},{"type":"string"}]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"address":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"lat":{"type":["string","number","null"],"description":"Latitude"},"lng":{"type":["string","number","null"],"description":"Longitude"},"country_id":{"type":["integer","string","null"],"description":"Pays"},"cp":{"type":["string","number","null"],"description":"Code postal"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"model_type":{"type":["string","null"],"description":"Model type"},"city":{"type":["string","null"],"description":"Ville"},"full_address":{"type":["string","null"],"description":"Adresse"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"country":{"type":["string","null"],"description":"Pays"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"contact":{"type":["string","null"],"description":"Tiers"},"is_main":{"type":["boolean","null"],"description":"Is main"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"country_id":{"type":["integer","string","null"],"description":"Pays"},"country":{"type":["string","null"],"description":"Pays"},"representation":{"type":["string","null"],"description":"Nom"},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"account_number_fmt":{"type":["string","null"],"description":"Numéro de compte"},"unpaid_total_solde":{"type":["integer","null"],"description":"Total non payé (T.T.C)"},"comment":{"type":["string","null"],"description":"Précisions"},"logo_url":{"type":"null","description":"Logo url"},"logo_thumb_url":{"type":"null","description":"Logo thumb url"},"type":{"type":["string","null"],"description":"Type"},"project_id":{"type":["integer","string","null"],"description":"Project id"},"person_morale":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"legal_form_id":{"type":["integer","string","null"],"description":"Forme juridique"},"rcs":{"type":["null","string"]},"tva_intra":{"type":["string","null"],"description":"N° TVA Intracommunautaire"},"naf":{"type":["string","null"],"description":"Activité"},"code_naf":{"type":["string","null"],"description":"Code Activité"},"legal_name":{"type":["string","null"],"description":"Nom juridique"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"foundation":{"type":["string","null"],"format":"date","description":"Date de création"},"siret":{"type":["string","number","null"],"description":"Siret"},"ape":{"type":["string","null"],"description":"APE"},"capital":{"type":["null","number"]},"ca":{"type":["null","number"]},"effectif":{"type":["null","number"]},"tva":{"type":["null","string"]},"autoliquidation_tva":{"type":["null","boolean"]},"siren":{"type":["null","string"]},"chorus_pro":{"type":["boolean","null"],"description":"Chorus Pro"},"legal_form":{"type":["string","null"],"description":"Forme juridique"},"tva_enabled":{"type":["boolean","null"],"description":"Utiliser la TVA"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"condition":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"payment_mode_id":{"type":["integer","string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["integer","string","null"],"description":"Type de règlement"},"billing_type_id":{"type":["integer","string","null"],"description":"Type de facturation"},"discount":{"type":["string","number","null"],"description":"Taux de remise"},"code_compta":{"type":["null","string"]},"banque":{"type":["null","string"]},"iban":{"type":["null","string"]},"bic":{"type":["null","string"]},"delivery_time":{"type":["null","number"]},"group_subscription_invoices":{"type":["boolean","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["boolean","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["null","string"]},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"billing_type":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["null","number"]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"notes":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/prospects/{id}/undelete":{"post":{"summary":"Undelete prospect","tags":["Contact - Prospects"],"responses":{"200":{"description":"Undeleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_detail"}}}}}}}}}
```

## Copy prospect

> Get copy of prospect for duplication

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"contact_prospect_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Date de création"},"updated_at":{"type":["string","null"],"description":"Date de modification"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"code":{"type":["string","null"],"description":"Code Client"},"origin_id":{"type":["integer","string","null"],"description":"Type de tiers"},"source_id":{"type":["integer","string","null"],"description":"Origine du contact"},"person_id":{"type":["integer","string","null"],"description":"Person id"},"address_id":{"type":["integer","string","null"],"description":"Address id"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"manager_id":{"type":["integer","string","null"],"description":"Commercial"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"account_number":{"type":["null","string"]},"internal":{"type":["null","boolean"]},"_address":{"type":["string","null"],"description":"Adresse"},"cp":{"type":["string","number","null"],"description":"Code postal"},"city":{"type":["string","null"],"description":"Ville"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"email":{"type":["string","null"],"format":"email","description":"Email"},"origin":{"type":["object","null"],"properties":{"color":{"type":["string","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"manager":{"type":["string","null"],"description":"Commercial"},"agency":{"type":["string","null"],"description":"Agence"},"source":{"type":["string","null"],"description":"Origine du contact"},"is_prospect":{"type":["boolean","null"],"description":"Is prospect"},"person":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"civility_id":{"type":["integer","string","null"],"description":"Civilité"},"name":{"type":["string","null"],"description":"Nom"},"lastname":{"type":["string","null"],"description":"Nom"},"firstname":{"type":["string","null"],"description":"Prénom"},"comment":{"type":["string","null"],"description":"Précisions"},"email":{"type":["string","null"],"format":"email","description":"Email"},"phone":{"type":["string","null"],"description":"Téléphone"},"portable":{"type":["string","null"],"description":"Mobile"},"fax":{"type":["string","null"],"description":"Fax"},"function":{"type":["string","null"],"description":"Statut"},"identity":{"type":["string","null"],"description":"Identity"},"web":{"type":["string","null"],"description":"Site Web"},"is_quote_recipient":{"type":["boolean","null"],"description":"Is quote recipient"},"is_invoice_recipient":{"type":["boolean","null"],"description":"Is invoice recipient"},"is_order_recipient":{"type":["boolean","null"],"description":"Is order recipient"},"is_delivery_recipient":{"type":["boolean","null"],"description":"Is delivery recipient"},"service":{"type":["string","null"],"description":"Service"},"civility":{"type":["string","null"],"description":"Civilité"},"contact":{"type":["string","null"],"description":"Tiers"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"agency_id":{"type":["integer","string","null"],"description":"Agence"},"agency":{"type":"null","description":"Agence"},"sector_id":{"type":["integer","string","null"],"description":"Secteur d'activité"},"sector":{"type":["string","null"],"description":"Secteur d'activité"},"contact_type":{"oneOf":[{"type":"object"},{"type":"string"}]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"address":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"address":{"type":["string","null"],"description":"Adresse"},"address_comp":{"type":["string","null"],"description":"Complément d'adresse"},"lat":{"type":["string","number","null"],"description":"Latitude"},"lng":{"type":["string","number","null"],"description":"Longitude"},"country_id":{"type":["integer","string","null"],"description":"Pays"},"cp":{"type":["string","number","null"],"description":"Code postal"},"model_id":{"type":["integer","string","null"],"description":"Tiers"},"model_type":{"type":["string","null"],"description":"Model type"},"city":{"type":["string","null"],"description":"Ville"},"full_address":{"type":["string","null"],"description":"Adresse"},"state":{"type":["string","null"],"description":"État / Région"},"recipient":{"type":["string","null"],"description":"Nom du destinataire"},"country":{"type":["string","null"],"description":"Pays"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"contact":{"type":["string","null"],"description":"Tiers"},"is_main":{"type":["boolean","null"],"description":"Is main"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"country_id":{"type":["integer","string","null"],"description":"Pays"},"country":{"type":["string","null"],"description":"Pays"},"representation":{"type":["string","null"],"description":"Nom"},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"account_number_fmt":{"type":["string","null"],"description":"Numéro de compte"},"unpaid_total_solde":{"type":["integer","null"],"description":"Total non payé (T.T.C)"},"comment":{"type":["string","null"],"description":"Précisions"},"logo_url":{"type":"null","description":"Logo url"},"logo_thumb_url":{"type":"null","description":"Logo thumb url"},"type":{"type":["string","null"],"description":"Type"},"project_id":{"type":["integer","string","null"],"description":"Project id"},"person_morale":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"legal_form_id":{"type":["integer","string","null"],"description":"Forme juridique"},"rcs":{"type":["null","string"]},"tva_intra":{"type":["string","null"],"description":"N° TVA Intracommunautaire"},"naf":{"type":["string","null"],"description":"Activité"},"code_naf":{"type":["string","null"],"description":"Code Activité"},"legal_name":{"type":["string","null"],"description":"Nom juridique"},"name":{"type":["string","null"],"description":"Nom"},"trade_name":{"type":["null","string"]},"foundation":{"type":["string","null"],"format":"date","description":"Date de création"},"siret":{"type":["string","number","null"],"description":"Siret"},"ape":{"type":["string","null"],"description":"APE"},"capital":{"type":["null","number"]},"ca":{"type":["null","number"]},"effectif":{"type":["null","number"]},"tva":{"type":["null","string"]},"autoliquidation_tva":{"type":["null","boolean"]},"siren":{"type":["null","string"]},"chorus_pro":{"type":["boolean","null"],"description":"Chorus Pro"},"legal_form":{"type":["string","null"],"description":"Forme juridique"},"tva_enabled":{"type":["boolean","null"],"description":"Utiliser la TVA"},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"condition":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"ID"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"contact_id":{"type":["integer","string","null"],"description":"Tiers"},"payment_mode_id":{"type":["integer","string","null"],"description":"Mode de règlement"},"term_condition_id":{"type":["integer","string","null"],"description":"Type de règlement"},"billing_type_id":{"type":["integer","string","null"],"description":"Type de facturation"},"discount":{"type":["string","number","null"],"description":"Taux de remise"},"code_compta":{"type":["null","string"]},"banque":{"type":["null","string"]},"iban":{"type":["null","string"]},"bic":{"type":["null","string"]},"delivery_time":{"type":["null","number"]},"group_subscription_invoices":{"type":["boolean","null"],"description":"Regrouper les factures d'abonnement"},"sepa_accepted":{"type":["boolean","null"],"description":"Mandat SEPA accepté"},"rum":{"type":["null","string"]},"payment_mode":{"type":["null","string"]},"term_condition":{"type":["null","string"]},"billing_type":{"type":["string","null"],"description":"Type de facturation"},"nb_invoices":{"type":["null","number"]},"inactivated_at":{"type":["string","null"],"description":"Archivé le"},"deleted_at":{"type":["string","null"],"description":"Deleted at"}},"required":[],"additionalProperties":true},"notes":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/prospects/{id}/copy":{"get":{"summary":"Copy prospect","tags":["Contact - Prospects"],"description":"Get copy of prospect for duplication","responses":{"200":{"description":"Copy data retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_prospect_detail"}}}}}}}}}
```

## GET /prospects/{id}/mpdf

> Export prospect to PDF

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/prospects/{id}/mpdf":{"get":{"summary":"Export prospect to PDF","tags":["Contact - Prospects"],"responses":{"200":{"description":"PDF file","content":{"application/pdf":{"schema":{"type":"string","contentMediaType":"application/octet-stream"}}}}}}}}}
```

## GET /prospects/{id}/mcsv

> Export prospect to CSV

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/prospects/{id}/mcsv":{"get":{"summary":"Export prospect to CSV","tags":["Contact - Prospects"],"responses":{"200":{"description":"CSV export data"}}}}}}
```

## Get prospects IDs

> Get list of prospects IDs

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"ids_response":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"}}},"required":["ids"]}}},"paths":{"/prospects/ids":{"get":{"summary":"Get prospects IDs","tags":["Contact - Prospects"],"description":"Get list of prospects IDs","parameters":[{"name":"search","in":"query","required":false,"description":"Tableau des différents attributs de recherche","schema":{"type":"object","properties":{"type_contact_id":{"type":"integer","description":"Type de tiers"},"person_id":{"type":"integer","description":"Person id"},"address_id":{"type":"integer","description":"Address id"},"comment":{"type":"string","description":"Précisions"},"created_by_id":{"type":"integer","description":"Created by id"},"updated_by_id":{"type":"integer","description":"Updated by id"},"inactivated_at":{"type":"string","description":"Archivé le"},"type":{"type":"string","description":"Type"},"code":{"type":"string","description":"Code Client"},"origin_id":{"type":"integer","description":"Type de tiers"},"sector_id":{"type":"integer","description":"Secteur d'activité"},"manager_id":{"type":"integer","description":"Commercial"},"account_number":{"type":"string","description":"Numéro de compte"},"logo":{"type":"string","description":"Logo"},"agency_id":{"type":"integer","description":"Agence"},"source_id":{"type":"integer","description":"Origine du contact"},"interconnection_id":{"type":"integer","description":"Interconnection id"},"internal":{"type":"boolean","description":"Interne"},"commission_id":{"type":"integer","description":"Commission id"},"import_json":{"type":"object","description":"Import json"},"dealv1_partner_id":{"type":"integer","description":"Dealv1 partner id"},"dealv1_logo_filename":{"type":"string","description":"Dealv1 logo filename"},"import_file_ok":{"type":"string","description":"Import file ok"},"import_file_error":{"type":"string","description":"Import file error"},"intervenant_type_id":{"type":"integer","description":"Intervenant type id"},"person":{"type":"string","description":"Personne"},"representation":{"type":"string","description":"Nom"},"index_search":{"type":"string","description":"Index search"},"email":{"type":"string","description":"Email"},"phone":{"type":"string","description":"Téléphone"},"portable":{"type":"string","description":"Mobile"},"_address":{"type":"string","description":"Adresse"},"cp":{"type":"string","description":"Code postal"},"city":{"type":"string","description":"Ville"},"country_id":{"type":"integer","description":"Pays"},"payment_mode":{"type":"string","description":"Mode de règlement"},"country":{"type":"string","description":"Pays"},"account_number_fmt":{"type":"string","description":"Numéro de compte"},"unpaid_total_solde":{"type":"string","description":"Total non payé (T.T.C)"},"exact_code":{"type":"string","description":"Exact code"}},"additionalProperties":false}},{"name":"sort","in":"query","required":false,"description":"Tableau des différents attributs","schema":{"type":"object","properties":{"type_contact_id":{"type":"string","description":"type_contact_id DESC NULLS LAST(Descendant) ou type_contact_id (Ascendant)"},"person_id":{"type":"string","description":"person_id DESC NULLS LAST(Descendant) ou person_id (Ascendant)"},"address_id":{"type":"string","description":"address_id DESC NULLS LAST(Descendant) ou address_id (Ascendant)"},"comment":{"type":"string","description":"comment DESC NULLS LAST(Descendant) ou comment (Ascendant)"},"created_by_id":{"type":"string","description":"created_by_id DESC NULLS LAST(Descendant) ou created_by_id (Ascendant)"},"updated_by_id":{"type":"string","description":"updated_by_id DESC NULLS LAST(Descendant) ou updated_by_id (Ascendant)"},"inactivated_at":{"type":"string","description":"inactivated_at DESC NULLS LAST(Descendant) ou inactivated_at (Ascendant)"},"type":{"type":"string","description":"type DESC NULLS LAST(Descendant) ou type (Ascendant)"},"code":{"type":"string","description":"code DESC NULLS LAST(Descendant) ou code (Ascendant)"},"origin_id":{"type":"string","description":"origin_id DESC NULLS LAST(Descendant) ou origin_id (Ascendant)"},"manager_id":{"type":"string","description":"manager_id DESC NULLS LAST(Descendant) ou manager_id (Ascendant)"},"account_number":{"type":"string","description":"account_number DESC NULLS LAST(Descendant) ou account_number (Ascendant)"},"logo":{"type":"string","description":"logo DESC NULLS LAST(Descendant) ou logo (Ascendant)"},"source_id":{"type":"string","description":"source_id DESC NULLS LAST(Descendant) ou source_id (Ascendant)"},"interconnection_id":{"type":"string","description":"interconnection_id DESC NULLS LAST(Descendant) ou interconnection_id (Ascendant)"},"internal":{"type":"string","description":"internal DESC NULLS LAST(Descendant) ou internal (Ascendant)"},"commission_id":{"type":"string","description":"commission_id DESC NULLS LAST(Descendant) ou commission_id (Ascendant)"},"import_json":{"type":"string","description":"import_json DESC NULLS LAST(Descendant) ou import_json (Ascendant)"},"dealv1_partner_id":{"type":"string","description":"dealv1_partner_id DESC NULLS LAST(Descendant) ou dealv1_partner_id (Ascendant)"},"dealv1_logo_filename":{"type":"string","description":"dealv1_logo_filename DESC NULLS LAST(Descendant) ou dealv1_logo_filename (Ascendant)"},"import_file_ok":{"type":"string","description":"import_file_ok DESC NULLS LAST(Descendant) ou import_file_ok (Ascendant)"},"import_file_error":{"type":"string","description":"import_file_error DESC NULLS LAST(Descendant) ou import_file_error (Ascendant)"},"intervenant_type_id":{"type":"string","description":"intervenant_type_id DESC NULLS LAST(Descendant) ou intervenant_type_id (Ascendant)"},"person":{"type":"string","description":"person DESC NULLS LAST(Descendant) ou person (Ascendant)"},"representation":{"type":"string","description":"representation DESC NULLS LAST(Descendant) ou representation (Ascendant)"},"email":{"type":"string","description":"email DESC NULLS LAST(Descendant) ou email (Ascendant)"},"phone":{"type":"string","description":"phone DESC NULLS LAST(Descendant) ou phone (Ascendant)"},"portable":{"type":"string","description":"portable DESC NULLS LAST(Descendant) ou portable (Ascendant)"},"_address":{"type":"string","description":"_address DESC NULLS LAST(Descendant) ou _address (Ascendant)"},"cp":{"type":"string","description":"cp DESC NULLS LAST(Descendant) ou cp (Ascendant)"},"city":{"type":"string","description":"city DESC NULLS LAST(Descendant) ou city (Ascendant)"},"country_id":{"type":"string","description":"country_id DESC NULLS LAST(Descendant) ou country_id (Ascendant)"},"payment_mode":{"type":"string","description":"payment_mode DESC NULLS LAST(Descendant) ou payment_mode (Ascendant)"},"country":{"type":"string","description":"country DESC NULLS LAST(Descendant) ou country (Ascendant)"},"account_number_fmt":{"type":"string","description":"account_number_fmt DESC NULLS LAST(Descendant) ou account_number_fmt (Ascendant)"},"agency_id":{"type":"string","description":"agency_id DESC NULLS LAST(Descendant) ou agency_id (Ascendant)"},"sector_id":{"type":"string","description":"sector_id DESC NULLS LAST(Descendant) ou sector_id (Ascendant)"},"unpaid_total_solde":{"type":"string","description":"unpaid_total_solde DESC NULLS LAST(Descendant) ou unpaid_total_solde (Ascendant)"}},"additionalProperties":false}},{"name":"page","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Number of items per page (-1 for all items/options mode)","schema":{"type":"integer"}},{"name":"scope","in":"query","required":false,"description":"Filter scope to apply","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Filter by tag name","schema":{"type":"string"}},{"name":"with_deleted","in":"query","required":false,"description":"Include soft-deleted items (1 to include, 0 or omit to exclude)","schema":{"type":"integer"}},{"name":"only_deleted","in":"query","required":false,"description":"Show only soft-deleted items (1 for only deleted)","schema":{"type":"integer"}},{"name":"with_inactivated","in":"query","required":false,"description":"Include inactivated items (1 to include)","schema":{"type":"integer"}},{"name":"only_inactivated","in":"query","required":false,"description":"Show only inactivated items (1 for only inactivated)","schema":{"type":"integer"}},{"name":"force_sort","in":"query","required":false,"description":"Force sorting even when custom search is used","schema":{"type":"string"}},{"name":"group_ids","in":"query","required":false,"description":"Comma-separated group IDs to filter by","schema":{"type":"string"}},{"name":"json_format","in":"query","required":false,"description":"Custom serialization format","schema":{"type":"string"}}],"responses":{"200":{"description":"IDs retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ids_response"}}}}}}}}}
```

## GET /prospects/tags

> Get available tags

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"tags_response":{"type":"array","items":{"type":"string"}}}},"paths":{"/prospects/tags":{"get":{"summary":"Get available tags","tags":["Contact - Prospects"],"responses":{"200":{"description":"Tags retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tags_response"}}}}}}}}}
```

## POST /prospects/{id}/add\_tag/{tag}

> Add tag to prospect

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/prospects/{id}/add_tag/{tag}":{"post":{"summary":"Add tag to prospect","tags":["Contact - Prospects"],"responses":{"200":{"description":"Tag added","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}}
```

## DELETE /prospects/{id}/remove\_tag/{tag}

> Remove tag from prospect

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/prospects/{id}/remove_tag/{tag}":{"delete":{"summary":"Remove tag from prospect","tags":["Contact - Prospects"],"responses":{"200":{"description":"Tag removed","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}}}}
```

## Get active responsibles

> Get list of active responsible users

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/prospects/active_responsibles":{"get":{"summary":"Get active responsibles","tags":["Contact - Prospects"],"description":"Get list of active responsible users","responses":{"200":{"description":"Active responsibles retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"models":{"type":"array","items":{"type":"object","properties":{"option_id":{"type":"integer","description":"User ID"},"option_label":{"type":"string","description":"User display name"}},"required":["option_id","option_label"]}}},"required":["models"]}}}}}}}}}
```

## Get active non-archived responsibles

> Get list of active non-archived responsible users

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/prospects/active_responsibles_not_archived":{"get":{"summary":"Get active non-archived responsibles","tags":["Contact - Prospects"],"description":"Get list of active non-archived responsible users","responses":{"200":{"description":"Active non-archived responsibles retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"models":{"type":"array","items":{"type":"object","properties":{"option_id":{"type":"integer","description":"User ID"},"option_label":{"type":"string","description":"User display name"}},"required":["option_id","option_label"]}}},"required":["models"]}}}}}}}}}
```

## Get all responsibles

> Get list of all responsible users

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/prospects/all_responsibles":{"get":{"summary":"Get all responsibles","tags":["Contact - Prospects"],"description":"Get list of all responsible users","responses":{"200":{"description":"All responsibles retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"models":{"type":"array","items":{"type":"object","properties":{"option_id":{"type":"integer","description":"User ID"},"option_label":{"type":"string","description":"User display name"}},"required":["option_id","option_label"]}}},"required":["models"]}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://geosquare-1.gitbook.io/geosquare-docs/contact-prospects.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
