> 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/configuration.md).

# Configuration

## GET /k3-gestion/locales.yml

> Ensemble des locales de la plateforme (non connecté)

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[],"paths":{"/k3-gestion/locales.yml":{"get":{"tags":["Configuration"],"summary":"Ensemble des locales de la plateforme (non connecté)","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalesResponse"}}}}}}}},"components":{"schemas":{"LocalesResponse":{"type":"object","additionalProperties":{"type":"object","properties":{"application":{"type":"object","additionalProperties":true},"settings":{"type":"object","additionalProperties":{"type":"object","properties":{"label_key":{"type":"string"},"description":{"type":"string"}}}}}}}}}}
```

## Ensemble des locales de la plateforme (connecté)

> Ici 2 est le numéro de l'application, car l'application permet de customizer les traductions

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LocalesResponse":{"type":"object","additionalProperties":{"type":"object","properties":{"application":{"type":"object","additionalProperties":true},"settings":{"type":"object","additionalProperties":{"type":"object","properties":{"label_key":{"type":"string"},"description":{"type":"string"}}}}}}}}},"paths":{"/k3-gestion/locales/{app_id}.yml":{"get":{"tags":["Configuration"],"summary":"Ensemble des locales de la plateforme (connecté)","description":"Ici 2 est le numéro de l'application, car l'application permet de customizer les traductions","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalesResponse"}}}}}}}}}
```

## Abonnement utilisateur

> Récupération des informations associées à l'abonnement de l'utilisateur

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserAccount":{"type":"object","properties":{"option_label":{"type":"string"},"option_id":{"type":"integer"},"id":{"type":"integer"},"model_name":{"type":"string"},"app_id":{"type":"integer"},"module":{"type":"string"},"module_human_name":{"type":"string"},"model_class_name":{"type":"string"},"username":{"type":"string","format":"email"},"email":{"type":"string","format":"email"},"role_id":{"type":"integer"},"role":{"$ref":"#/components/schemas/Role"},"has_see_last_version":{"type":"boolean"},"hide_new_version":{"type":"boolean"},"super_admin":{"type":"boolean"},"k3_super_admin":{"type":"boolean"},"stripe_customer_active":{"type":"boolean"},"secondary_users":{"type":"array","items":{"type":"object"}},"subscription_remaining_days":{"type":"integer"},"subscription_status":{"type":"string"},"subscription_stripe":{"type":"boolean"},"subscription_nb_users":{"type":"integer"},"subscription_can_add_users":{"type":"boolean"},"subscription_nb_documents":{"type":["integer","null"]},"subscription_size_disk":{"type":"integer"},"interconnection_has_children":{"type":"boolean"},"interconnection_has_parent":{"type":"boolean"},"subscription_cancel_at_period_end":{"type":"boolean"},"subscription_stripe_card_last4":{"type":["string","null"]},"subscription_stripe_card_exp":{"type":["string","null"]},"subscription_stripe_error_card":{"type":"boolean"},"subscription_trial_period":{"type":"boolean"},"client_area_slug":{"type":["string","null"]},"client_area_show_catalog":{"type":["boolean","null"]},"client_area_show_prices":{"type":["boolean","null"]},"client_area_is_catalog_public":{"type":["boolean","null"]},"client_area_allow_order":{"type":["boolean","null"]},"current_nb_users":{"type":"integer"},"kpulse_version":{"type":["string","null"]},"token_disabled":{"type":"boolean"},"inactivated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"},"created_by":{"type":"string"}}},"Role":{"type":"object","properties":{"id":{"type":"integer"},"application_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"inactivated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"css_class":{"type":"string"},"is_client_area":{"type":"boolean"}}}}},"paths":{"/k3-auth/account/my":{"get":{"tags":["Configuration"],"summary":"Abonnement utilisateur","description":"Récupération des informations associées à l'abonnement de l'utilisateur","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}}}}}}}}
```

## Informations sur l'application

> Informations complètes sur l'application

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApplicationInfo":{"type":"object","properties":{"option_label":{"type":"string"},"option_id":{"type":"integer"},"id":{"type":"integer"},"model_name":{"type":"string"},"app_id":{"type":"integer"},"module":{"type":"string"},"module_human_name":{"type":"string"},"model_class_name":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"admin_auth_app?":{"type":"boolean"},"domain":{"type":["string","null"]},"theme":{"type":"string"},"type":{"type":"string"},"route_path":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"phone":{"type":"string"},"register_source":{"type":"string"},"register_page":{"type":"string"},"nb_collaborators":{"type":["integer","null"]},"active":{"type":"boolean"},"pricing_key":{"type":"string"},"admin_login":{"type":"string"},"email":{"type":"string","format":"email"},"sign_in_stat":{"type":"object","properties":{"nbr":{"type":"integer"},"date":{"type":"string"}}},"admin_auth_app":{"type":"boolean"},"modules":{"type":"array","items":{"$ref":"#/components/schemas/Module"}},"applications_modules":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationModule"}},"module_refs":{"type":"array","items":{"type":"string"}},"enabled_modules":{"type":"array","items":{"type":"string"}},"client_area_enable":{"type":"boolean"},"client_area_id":{"type":"integer"},"client_area_show_catalog":{"type":"boolean"},"client_area_show_prices":{"type":"boolean"},"client_area_is_catalog_public":{"type":"boolean"},"client_area_allow_order":{"type":"boolean"},"inactivated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"updated_by_id":{"type":["integer","null"]},"updated_by":{"type":"string"},"created_by_id":{"type":["integer","null"]},"created_by":{"type":"string"}}},"Module":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"api":{"type":"string","format":"uri"},"description":{"type":"string"},"created_by_id":{"type":["integer","null"]},"updated_by_id":{"type":["integer","null"]},"inactivated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"ref":{"type":"string"},"route_path":{"type":"string"},"application":{"type":"boolean"},"sub_modules":{"type":"array","items":{"type":"string"}}}},"ApplicationModule":{"type":"object","properties":{"id":{"type":"integer"},"application_id":{"type":"integer"},"module_id":{"type":"integer"},"application":{"$ref":"#/components/schemas/ApplicationShort"},"module":{"$ref":"#/components/schemas/Module"}}},"ApplicationShort":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"},"description":{"type":"string"},"created_by_id":{"type":["integer","null"]},"updated_by_id":{"type":["integer","null"]},"inactivated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"domain":{"type":["string","null"]},"theme":{"type":"string"},"type":{"type":"string"},"test":{"type":["boolean","null"]},"register_source":{"type":"string"},"register_campaign":{"type":"string"},"register_page":{"type":"string"},"phone":{"type":"string"},"base_seed_valid":{"type":["boolean","null"]},"stripe_customer_secret":{"type":["string","null"]},"demo_realised":{"type":"boolean"},"discount_realised":{"type":"boolean"},"specific_use":{"type":"boolean"},"qualified":{"type":["boolean","null"]},"nb_collaborators":{"type":["integer","null"]},"enable_for_synchro":{"type":"boolean"}}}}},"paths":{"/k3-auth/account/application":{"get":{"tags":["Configuration"],"summary":"Informations sur l'application","description":"Informations complètes sur l'application","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInfo"}}}}}}}}}
```

## GET /k3-geosquare/account\_limits

> Limites de l'abonnement associées au plan

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AccountLimits":{"type":"object","properties":{"licence":{"type":"object","properties":{"nb_documents":{"type":["integer","null"]},"size_disk":{"type":"integer"}}},"feature_flags":{"type":"array","items":{"type":"string"}},"elements":{"type":"object","properties":{"quote":{"type":"integer"},"invoice":{"type":"integer"}}}}}}},"paths":{"/k3-geosquare/account_limits":{"get":{"tags":["Configuration"],"summary":"Limites de l'abonnement associées au plan","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountLimits"}}}}}}}}}
```

## GET /k3-geosquare/profiles/by\_user/{user\_id}

> Profil de l'utlisateur

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserProfile":{"type":"object","properties":{"option_label":{"type":"string"},"option_id":{"type":"integer"},"id":{"type":"integer"},"model_name":{"type":"string"},"app_id":{"type":"integer"},"module":{"type":"string"},"module_human_name":{"type":"string"},"model_class_name":{"type":"string"},"email":{"type":["string","null"],"format":"email"},"firstname":{"type":"string"},"lastname":{"type":"string"},"phone":{"type":["string","null"]},"job":{"type":["string","null"]},"user_id":{"type":"integer"},"avatar":{"type":["string","null"]},"user_avatar":{"type":["string","null"]},"user_username":{"type":"string","format":"email"},"user_email":{"type":"string","format":"email"},"user_created_at":{"type":"string","format":"date-time"},"user_role":{"type":"string"},"user_role_id":{"type":"integer"},"swan_has_membership":{"type":"boolean"},"swan_account_membership_id":{"type":["string","null"]},"contact_id":{"type":["integer","null"]},"user_client_area_id":{"type":["integer","null"]},"user_client_area_slug":{"type":["string","null"]},"agency_id":{"type":"integer"},"responsible_id":{"type":["integer","null"]},"profession_id":{"type":["integer","null"]},"affiliated_agency_ids":{"type":"array","items":{"type":"integer"}},"has_customer":{"type":"boolean"},"description":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"email":{"type":["string","null"]},"user_username":{"type":"string"},"user_email":{"type":"string"}}},"agency":{"type":"string"},"affiliated_agencies":{"type":"array","items":{"type":"string"}},"responsible":{"type":"string"},"profession":{"type":["string","null"]},"inactivated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"tag_names":{"type":"array","items":{"type":"string"}},"updated_by_id":{"type":"integer"},"updated_by":{"type":"string"},"created_by_id":{"type":"integer"},"created_by":{"type":"string"}}}}},"paths":{"/k3-geosquare/profiles/by_user/{user_id}":{"get":{"tags":["Configuration"],"summary":"Profil de l'utlisateur","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}}}}}}}
```

## Liste des permissions (AUTH)

> Récupération des permissions de l'utilisateur côté AUTH

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PermissionKeys":{"type":"object","properties":{"models":{"type":"array","items":{"type":"string"}}}}}},"paths":{"/k3-auth/permission_keys":{"get":{"tags":["Configuration"],"summary":"Liste des permissions (AUTH)","description":"Récupération des permissions de l'utilisateur côté AUTH","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionKeys"}}}}}}}}}
```

## Liste des permissions

> Récupération des permissions de l'utilisateur côté APP

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PermissionKeys":{"type":"object","properties":{"models":{"type":"array","items":{"type":"string"}}}}}},"paths":{"/k3-geosquare/permission_keys":{"get":{"tags":["Configuration"],"summary":"Liste des permissions","description":"Récupération des permissions de l'utilisateur côté APP","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionKeys"}}}}}}}}}
```

## Liste des settings de l'application

> Les settings permettent de stocker des paramètres sur 3 niveaux. Au niveau de l'application owner\_type et owner\_id sont null, au niveau de la classe du modèle owner\_type est défini avec le nom du modèle (Ex: K3::Sale::Invoice). Et au niveau d'un élément, owner\_type et owner\_id sont définis, cela permet par exemple de stocker la configuration PDF spécifique à chaque document de vente.

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SettingsList":{"type":"object","properties":{"models":{"type":"array","items":{"$ref":"#/components/schemas/Setting"}}}},"Setting":{"type":"object","properties":{"option_label":{"type":"string"},"option_id":{"type":"integer"},"id":{"type":"integer"},"model_name":{"type":"string"},"app_id":{"type":"integer"},"module":{"type":"string"},"module_human_name":{"type":"string"},"model_class_name":{"type":"string"},"_value":{"type":"boolean"},"type":{"type":"string"},"displayed_type":{"type":"string"},"key":{"type":"string"},"input_type":{"type":"string"},"options":{"type":["string","null"]},"visible":{"type":"boolean"},"public":{"type":"boolean"},"owner_type":{"type":"string"},"owner_id":{"type":"integer"},"ordre":{"type":"integer"},"category_id":{"type":"integer"},"category":{"type":"string"},"category_key":{"type":"string"},"default":{"type":["string","null"]},"inactivated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"updated_by_id":{"type":["integer","null"]},"created_by_id":{"type":["integer","null"]}}}}},"paths":{"/k3-geosquare/options/settings":{"get":{"tags":["Configuration"],"summary":"Liste des settings de l'application","description":"Les settings permettent de stocker des paramètres sur 3 niveaux. Au niveau de l'application owner_type et owner_id sont null, au niveau de la classe du modèle owner_type est défini avec le nom du modèle (Ex: K3::Sale::Invoice). Et au niveau d'un élément, owner_type et owner_id sont définis, cela permet par exemple de stocker la configuration PDF spécifique à chaque document de vente.","parameters":[{"name":"owner_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"owner_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsList"}}}}}}}}}
```

## GET /k3-geosquare/options/options

> Liste des options de la plateforme

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OptionsList":{"type":"object","properties":{"models":{"type":"array","items":{"$ref":"#/components/schemas/Option"}},"total_count":{"type":"integer"}}},"Option":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"},"key":{"type":"string"},"default":{"type":"boolean"},"code":{"type":"string"},"sort":{"type":"integer"},"is_readonly":{"type":["boolean","null"]},"open":{"type":"boolean"},"accept":{"type":"boolean"},"parent_id":{"type":["integer","null"]},"inactivated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"secondary_code":{"type":["string","null"]},"account_allocation_id":{"type":["integer","null"]},"parent":{"type":"string"},"children":{"type":"array","items":{"type":"object"}},"option_label":{"type":"string"},"option_id":{"type":"integer"},"model_name":{"type":"string"},"app_id":{"type":"integer"},"module":{"type":"string"},"module_human_name":{"type":"string"},"model_class_name":{"type":"string"},"code_compta":{"type":"string"},"code_compta_achat":{"type":["string","null"]},"account_allocation":{"type":["string","null"]}}}}},"paths":{"/k3-geosquare/options/options":{"get":{"tags":["Configuration"],"summary":"Liste des options de la plateforme","parameters":[{"name":"per_page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"with_inactivated","in":"query","required":false,"schema":{"type":"integer"}},{"name":"optimization","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsList"}}}}}}}}}
```


---

# 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/configuration.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.