API Reference

Introduction

The Markt API is a RESTful API that uses JSON for request and response payloads. All endpoints return standard HTTP status codes and use Bearer token authentication.

Authentication

Authenticate API requests using a Sanctum Bearer token. Include the token in the Authorization header of every request.

Authorization: Bearer YOUR_API_TOKEN

API tokens are scoped to your team. Generate tokens from your team settings in the dashboard.

Base URL

All API requests should be made to:

https://your-domain.com/api/v1

Rate Limiting

API requests are limited to 60 requests per minute per API token. Rate limit information is included in response headers:

• X-RateLimit-Limit — Maximum requests allowed
• X-RateLimit-Remaining — Remaining requests in current window
• X-RateLimit-Reset — Unix timestamp when limit resets

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

Validation errors return a 422 status with a JSON object containing error messages:

{
  "message": "The given data was invalid.",
  "errors": {
    "email": ["The email field is required."]
  }
}

Contacts

Manage your contact list with full CRUD operations. Contacts can be segmented and assigned to campaigns.

{
  "data": [
    {
      "id": 1,
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Doe",
      "status": "active",
      "created_at": "2024-01-15T10:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  }
}

{
  "id": 1,
  "email": "[email protected]",
  "first_name": "John",
  "last_name": "Doe",
  "status": "active",
  "created_at": "2024-01-15T10:00:00Z"
}

{
  "id": 1,
  "email": "[email protected]",
  "first_name": "John",
  "last_name": "Doe",
  "status": "active",
  "segments": [
    {
      "id": 1,
      "name": "VIP Customers"
    }
  ],
  "created_at": "2024-01-15T10:00:00Z"
}

Campaigns

Read campaign details and control campaign execution. Use the API to start, pause, and monitor your email campaigns.

{
  "id": 1,
  "name": "Welcome Series",
  "status": "active",
  "steps": [
    {
      "id": 1,
      "subject": "Welcome!",
      "delay_days": 0
    }
  ],
  "email_accounts": [
    {
      "id": 1,
      "email": "[email protected]"
    }
  ]
}