# API Endpoints

Estimated time: 8 minutes
Difficulty: Intermediate

LaraCoreKit provides a set of REST API endpoints for accessing data programmatically from mobile apps, SPAs, or third-party integrations.

Base URL

https://www.laracorekit.com/api

All API responses use JSON format. Always include:

Accept: application/json

Authentication Endpoints

User Endpoints

Blog Endpoints

Settings Endpoint

Pagination

List endpoints return paginated responses:

{
    "data": [
        { "id": 1, "title": "First Post", "slug": "first-post" }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 5,
        "per_page": 15,
        "total": 72
    },
    "links": {
        "first": "https://www.laracorekit.com/api/posts?page=1",
        "next":  "https://www.laracorekit.com/api/posts?page=2",
        "prev":  null,
        "last":  "https://www.laracorekit.com/api/posts?page=5"
    }
}

Pass ?page=2&per_page=20 to paginate.

Query Parameters

For list endpoints:

GET /api/posts?locale=en&status=published&page=1&per_page=12

Error Responses

{
    "message": "Unauthenticated.",
    "errors": {}
}

Validation Error

{
    "message": "The email field is required.",
    "errors": {
        "email": ["The email field is required."]
    }
}

Adding a New API Endpoint

1. Create a controller in your module:

namespace Modules\Blog\Http\Controllers\Api;

use Illuminate\Http\JsonResponse;
use Illuminate\Routing\Controller;
use Modules\Blog\Models\Post;

class PostApiController extends Controller
{
    public function index(): JsonResponse
    {
        $posts = Post::published()
            ->locale(request('locale', 'en'))
            ->latest()
            ->paginate(request('per_page', 15));

        return response()->json($posts);
    }

    public function show(string $slug): JsonResponse
    {
        $post = Post::published()->where('slug', $slug)->firstOrFail();

        return response()->json(['data' => $post]);
    }
}

2. Register routes in modules/Blog/routes/api.php:

Route::prefix('api')->group(function () {
    Route::get('/posts', [PostApiController::class, 'index']);
    Route::get('/posts/{slug}', [PostApiController::class, 'show']);
});

Next Steps

API Auth Flow →