Aller au contenu
TellMeHow Documentation
fr

Documentation de l’API

Confidentialité

Confidentialité : 23 opérations de l’API, avec leurs paramètres, leur corps, leurs réponses et un exemple curl.

GET /compliance-documents/{document}/download

Lecture privacy.compliance-documents.download

Paramètres

document chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/compliance-documents/{document}/download" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/compliance-documents

Lecture privacy.engagements.compliance-documents.index

Paramètres

engagement chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/compliance-documents" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/compliance-documents

Écriture privacy.engagements.compliance-documents.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • kind object requis

    une valeur parmi cse_note dpia_template processing_agreement classification_note

  • locale string requis

    une valeur parmi en fr

  • engagement_id string | null

    longueur : exactement 26

Réponses

  • 201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/compliance-documents" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"kind":"cse_note","locale":"en"}'

GET /engagements/{engagement}/deletion-requests

Lecture privacy.engagements.deletion-requests.index

Paramètres

engagement chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/deletion-requests" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/deletion-requests

Écriture privacy.engagements.deletion-requests.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • participant_id string requis

    longueur : exactement 26

Réponses

  • 201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/deletion-requests" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"participant_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

POST /engagements/{engagement}/deletion-requests/{deletion}/execute

Écriture privacy.engagements.deletion-requests.execute

Paramètres

engagement chemin
Identifiant (ULID).
deletion chemin
Identifiant (ULID).

Réponses

  • 201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/deletion-requests/{deletion}/execute" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/privacy/participants

Lecture privacy.engagements.participants

Paramètres

engagement chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/privacy/participants" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/raw-access-logs

Lecture privacy.engagements.raw-access-logs

Paramètres

engagement chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/raw-access-logs" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/retention

Lecture privacy.engagements.retention

Paramètres

engagement chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/retention" \
  -H "Authorization: Bearer pat_…"

GET /privacy/engagements

Lecture privacy.engagements

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/privacy/engagements" \
  -H "Authorization: Bearer pat_…"

GET /privacy/enums/compliance-kinds

Lecture privacy.enums.compliance-kinds

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/privacy/enums/compliance-kinds" \
  -H "Authorization: Bearer pat_…"

GET /privacy/enums/deletion-statuses

Lecture privacy.enums.deletion-statuses

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/privacy/enums/deletion-statuses" \
  -H "Authorization: Bearer pat_…"

GET /privacy/enums/purge-kinds

Lecture privacy.enums.purge-kinds

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/privacy/enums/purge-kinds" \
  -H "Authorization: Bearer pat_…"

GET /privacy/enums/raw-resources

Lecture privacy.enums.raw-resources

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/privacy/enums/raw-resources" \
  -H "Authorization: Bearer pat_…"

GET /workspace/compliance-documents

Lecture privacy.workspace.compliance-documents.index

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/workspace/compliance-documents" \
  -H "Authorization: Bearer pat_…"

POST /workspace/compliance-documents

Écriture privacy.workspace.compliance-documents.store

Corps application/json

  • kind object requis

    une valeur parmi cse_note dpia_template processing_agreement classification_note

  • locale string requis

    une valeur parmi en fr

  • engagement_id string | null

    longueur : exactement 26

Réponses

  • 201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/workspace/compliance-documents" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"kind":"cse_note","locale":"en"}'

GET /workspace/deletion-requests

Lecture privacy.workspace.deletion-requests

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/workspace/deletion-requests" \
  -H "Authorization: Bearer pat_…"

GET /workspace/purge-runs

Lecture privacy.workspace.purge-runs

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/workspace/purge-runs" \
  -H "Authorization: Bearer pat_…"

GET /workspace/raw-access-logs

Lecture privacy.workspace.raw-access-logs

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/workspace/raw-access-logs" \
  -H "Authorization: Bearer pat_…"

GET /workspace/retention

Lecture privacy.workspace.retention

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/workspace/retention" \
  -H "Authorization: Bearer pat_…"

GET /workspace/support-grants

Lecture privacy.workspace.support-grants.index

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/workspace/support-grants" \
  -H "Authorization: Bearer pat_…"

GET /workspace/support-grants/operators

Lecture privacy.workspace.support-grants.operators

Paramètres

cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/workspace/support-grants/operators" \
  -H "Authorization: Bearer pat_…"

DELETE /workspace/support-grants/{grant}

Écriture privacy.workspace.support-grants.destroy

Paramètres

grant chemin
Identifiant (ULID).

Réponses

  • 204 Supprimé, sans contenu.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/workspace/support-grants/{grant}" \
  -H "Authorization: Bearer pat_…"