List the marketing enquiries

Admin only. Returns a page of landing page enquiries, newest first. Search matches the name, the email, or the message, and page_size caps the rows.

GET/api/v1/marketing/contacts

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Query parameters

searchstring

Match the name, the email, or the message.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

Rows per page, capped at 200. Defaults to 50.

Responses

200

A page of enquiries

itemsobject[]required

Show properties

Array of object

idstringrequired

namestringrequired

emailstringrequired

phonestringrequired

topicstringrequired

messagestringrequired

created_atstringrequired

totalintegerrequired

min -9007199254740991 · max 9007199254740991

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

401

Not authenticated

detailstringrequired

403

Caller is not an admin

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

searchqueryMatch the name, the email, or the message.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 50.

Request

curl -X GET 'http://localhost:8000/api/v1/marketing/contacts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("http://localhost:8000/api/v1/marketing/contacts", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/marketing/contacts",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "email": "string",
      "phone": "string",
      "topic": "string",
      "message": "string",
      "created_at": "string"
    }
  ],
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991
}

{
  "detail": "string"
}

{
  "detail": "string"
}