Skip to main content
GET
/
newsletters
curl -X GET "https://api.tktchurch.com/v1/newsletters?page=1&per=10" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "January Church Updates",
      "content": "Welcome to our first newsletter of 2024...",
      "image": {
        "id": "file-123",
        "url": "https://cdn.tktchurch.com/files/newsletter-image.jpg"
      },
      "imageUrl": null,
      "pdf": {
        "id": "file-456",
        "url": "https://cdn.tktchurch.com/files/newsletter.pdf"
      },
      "pdfUrl": null,
      "hasPdf": true,
      "status": "published",
      "publishDate": "2024-01-01T12:00:00Z",
      "recipientCount": 150,
      "createdAt": "2023-12-30T15:00:00Z",
      "updatedAt": "2024-01-01T12:00:00Z",
      "createdBy": "user-123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 45
  }
}
This endpoint requires authentication and the readNewsletter permission.

Query Parameters

page
integer
default:"1"
Page number for pagination
per
integer
default:"10"
Number of newsletters per page

Response

items
array
Array of newsletter objects
metadata
object
Pagination metadata

Error Responses

error
object
Error details when the request fails
Common error cases:
  • 401 Unauthorized: Missing or invalid access token
  • 403 Forbidden: Missing required permission
curl -X GET "https://api.tktchurch.com/v1/newsletters?page=1&per=10" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "January Church Updates",
      "content": "Welcome to our first newsletter of 2024...",
      "image": {
        "id": "file-123",
        "url": "https://cdn.tktchurch.com/files/newsletter-image.jpg"
      },
      "imageUrl": null,
      "pdf": {
        "id": "file-456",
        "url": "https://cdn.tktchurch.com/files/newsletter.pdf"
      },
      "pdfUrl": null,
      "hasPdf": true,
      "status": "published",
      "publishDate": "2024-01-01T12:00:00Z",
      "recipientCount": 150,
      "createdAt": "2023-12-30T15:00:00Z",
      "updatedAt": "2024-01-01T12:00:00Z",
      "createdBy": "user-123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 45
  }
}