Espace et compte

GET /me

Lecture me.show

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/me" \
  -H "Authorization: Bearer pat_…"

PATCH /me

Écriture me.update

Corps application/json

name string

longueur : au moins 1 longueur : au plus 255
locale string

une valeur parmi en fr

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/me" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","locale":"en"}'

GET /workspace

Lecture workspace.show

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" \
  -H "Authorization: Bearer pat_…"

PATCH /workspace

Écriture workspace.update

Corps application/json

name string

longueur : au moins 1 longueur : au plus 255
display_name string

longueur : au moins 1 longueur : au plus 255
locales array<string>

éléments : au moins 1 une valeur parmi en fr
default_locale string

une valeur parmi en fr
retention_raw_days integer

au moins 1 au plus 3650
retention_deliverable_days integer

au moins 1 au plus 3650
settings array<object>
settings.require_2fa_for_consultants boolean
settings.participant_email_code_default boolean
settings.platform_keys_allowed boolean

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/workspace" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","display_name":"…","locales":[]}'

PATCH /workspace/branding

Écriture workspace.branding.update

Corps application/json

primary_color string | null
accent_color string | null
email_sender_name string

longueur : au moins 1 longueur : au plus 120

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/workspace/branding" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"primary_color":"…","accent_color":"…","email_sender_name":"…"}'

POST /workspace/branding/logo

Écriture workspace.branding.logo

Corps multipart/form-data

logo file requis

longueur : au plus 1024
dark boolean

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/branding/logo" \
  -H "Authorization: Bearer pat_…" \
  -F "logo=@./file.pdf"

DELETE /workspace/branding/logo

Écriture workspace.branding.logo.destroy

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/branding/logo" \
  -H "Authorization: Bearer pat_…"

GET /workspace/dashboard

Lecture workspace.dashboard

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/dashboard" \
  -H "Authorization: Bearer pat_…"

GET /workspace/invitations

Lecture workspace.invitations.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/invitations" \
  -H "Authorization: Bearer pat_…"

POST /workspace/invitations

Écriture workspace.invitations.store

Corps application/json

email string requis

longueur : au plus 255 format email
role object requis

une valeur parmi admin consultant

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/invitations" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"email":"name@example.com","role":"admin"}'

DELETE /workspace/invitations/{invitation}

Écriture workspace.invitations.destroy

Paramètres

invitation 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/invitations/{invitation}" \
  -H "Authorization: Bearer pat_…"

GET /workspace/members

Lecture workspace.members.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/members" \
  -H "Authorization: Bearer pat_…"

PATCH /workspace/members/{member}

Écriture workspace.members.update

Paramètres

member chemin: Identifiant (ULID).

Corps application/json

role object requis

une valeur parmi admin consultant

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/workspace/members/{member}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"role":"admin"}'

DELETE /workspace/members/{member}

Écriture workspace.members.destroy

Paramètres

member 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/members/{member}" \
  -H "Authorization: Bearer pat_…"

GET /workspaces/enums/roles

Lecture workspaces.enums.roles

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/workspaces/enums/roles" \
  -H "Authorization: Bearer pat_…"

GET /workspaces/enums/statuses

Lecture workspaces.enums.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/workspaces/enums/statuses" \
  -H "Authorization: Bearer pat_…"