SchoolScout API
User email promptsPromptidEmails

Get generated emails for prompt

Get generated emails associated with an email prompt, ordered newest first.

GET
/user-email-prompts/{promptId}/emails

Get generated emails associated with an email prompt, ordered newest first.

AuthorizationBearer <token>

API key (sk_live_... prefix). Generate keys in the UI under Settings > API Keys, then send it as Authorization: Bearer sk_live_...

In: header

Path Parameters

promptId*string
Formatuuid

Query Parameters

limit?integer
Default50
Rangevalue <= 200
offset?integer
Default0

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/user-email-prompts/497f6eca-6276-4993-bfeb-53cbbbba6f08/emails"
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "contact_id": "550e8400-e29b-41d4-a716-446655440000",
      "email_prompt_id": "550e8400-e29b-41d4-a716-446655440000",
      "subject": "string",
      "body": "string",
      "status": "generated",
      "generation_metadata": {
        "property1": null,
        "property2": null
      },
      "generated_at": "string",
      "created_at": "string",
      "prompt_name": "string",
      "contact_name": "string",
      "contact_email": "string"
    }
  ],
  "pagination": {
    "total": -9007199254740991,
    "limit": -9007199254740991,
    "offset": -9007199254740991,
    "has_more": true
  }
}
{
  "error": "string",
  "message": "string",
  "statusCode": -9007199254740991
}
Empty
Empty