Lire une page d'inscription

GET /api/v1/signup-pages/{id} Une page d'inscription, avec son content — c'est l'appel qui vous donne le HTML que la liste ne transporte pas.

Autorisation

Rôle dans l'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERAutorisé
Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Paramètres de chemin

ParamètreTypeDescription
idstringObligatoire. La page à lire

Exemple

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/signup-pages/$SIGNUP_PAGE_ID"

Réponse

  • 200 OK — la page et son HTML.
  • 401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
  • 404 Not Found — aucune page de ce type, ou elle appartient à une autre organisation. L'API ne confirme jamais qu'un identifiant existe à un appelant qui n'y a pas droit.
  • 429 Too Many Requests — la clé a dépassé sa limite de débit.

Champs de la réponse

ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.idstringIdentifiant unique de la page
data.namestringNom interne, celui que seule votre équipe voit
data.slugstringDernière partie de l'adresse publique
data.statusstringdraft ou published
data.listIdstringLa liste qui reçoit les inscrits
data.contentstringLe HTML de la page
data.sourceTemplateNamestring | nullLe thème dont elle a été copiée, null pour un HTML collé
data.heroTitlestringLe titre que lisent les visiteurs
data.heroSubtitlestring | nullLe sous-titre, null s'il n'est pas défini
data.submitLabelstringLibellé du bouton d'inscription
data.successMessagestringAffiché après une inscription quand il n'y a pas de redirection
data.redirectUrlstring | nullOù va le visiteur après s'être inscrit, null pour aucune redirection
data.collectFirstNamebooleanSi le formulaire demande un prénom
data.collectLastNamebooleanSi le formulaire demande un nom de famille
data.createdAtstringDate de création ISO
data.updatedAtstringDate ISO de la dernière modification

Exemple de réponse

json
{
  "success": true,
  "data": {
    "id": "3d3d3d3d-4444-4eee-9fff-000011112222",
    "name": "Newsletter footer",
    "slug": "newsletter",
    "status": "published",
    "listId": "9f8e7d6c-1111-4bbb-8ccc-ddddeeeeffff",
    "content": "<html><body><h1>{{heroTitle}}</h1>{{form}}</body></html>",
    "sourceTemplateName": "Minimal",
    "heroTitle": "Join the list",
    "heroSubtitle": "One email a month, no more.",
    "submitLabel": "Sign me up",
    "successMessage": "Check your inbox.",
    "redirectUrl": null,
    "collectFirstName": true,
    "collectLastName": false,
    "createdAt": "2026-08-01T10:00:00.000Z",
    "updatedAt": "2026-08-02T10:00:00.000Z"
  }
}

Remarques

  • L'organisation ne figure jamais dans la réponse. C'est celle qu'ouvre votre clé, et vous la connaissez déjà.
  • Une page draft répond 200 ici, alors même que son adresse publique répond par une page introuvable. Ce sont deux questions différentes.

Voir aussi