Content API

Enable the API

Enable the API in your config or with an environment variable.

// config/statamic/api.php
'enabled' => true,

STATAMIC_API_ENABLED=true

Endpoints

https://yourdomain.tld/api/{endpoint} You may send requests to the following endpoints:

• Entries / Entry
• Taxonomy Terms / Taxonomy Term
• Assets / Asset
• Globals / Global
• Users / User

Customizing the API URL

You may customize the route in your API config file or with an environment variable.

// config/statamic/api.php
 'route' => 'not_api',

STATAMIC_API_ROUTE=not_api

Filtering

You may filter results by using the filter query parameter.

/endpoint?filter[{field}:{condition}]={value}

You may use the conditions available to the collection tag. eg. contains, is, isnt (or not), etc. For example:

/endpoint?filter[title:contains]=awesome&filter[featured]=true

This would filter down the results to where the title value contains the string "awesome", and the featured value is true. When you omit the condition, it defaults to is.

Sorting

You may sort results by using the sort query parameter:

/endpoint?sort=field

You can sort in reverse by prefixing the field with a -:

/endpoint?sort=-field

You may sort by multiple fields by comma separating them. The reverse flag can be combined with any field:

/endpoint?sort=one,-two,three

Selecting Fields

You may specify which top level fields should be included in the response.

/endpoint?fields=id,title,content

Pagination

Results will be paginated into 25 items per page by default. You may specify the items per page and which page you are viewing with the limit and page parameters:

/endpoint?limit=10&page=1

The response will contain your data, links to easily get next/previous URLs, and meta information for more easily creating a paginator.

{
    "data": [
        {...},
        {...},
    ],
    "links": {
        "first": "/endpoint?limit=10&page=1",
        "last": "/endpoint?limit=10&page=3",
        "prev": null,
        "next": "/endpoint?limit=10&page=2",
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "to": 10,
        "total": 29,
        "per_page": 10,
        "path": "/endpoint",
    }
}

Entries

GET /api/collections/{collection}/entries

Gets entries within a collection.

{
  "data": [
    {
      "title": "My First Day"
    }
  ],
  "links": {...},
  "meta": {...}
}

Entry

GET /api/collections/{collection}/entries/{id}

Gets a single entry.

{
  "data": {
    "title": "My First Day"
  }
}

Taxonomy Terms

GET /api/taxonomies/{taxonomy}/terms

Gets terms in a taxonomy.

{
  "data": [
    {
      "title": "Music",
    }
  ],
  "links": {...},
  "meta": {...}
}

Taxonomy Term

GET /api/taxonomies/{taxonomy}/terms/{slug}

Gets a single taxonomy term.

{
  "data": {
    "title": "My First Day"
  }
}

Globals

GET /api/globals

Gets all globals.

{
  "data": [
    {
      "handle": "global",
      "api_url": "http://example.com/api/globals/global",
      "foo": "bar",
    },
    {
      "handle": "another",
      "api_url": "http://example.com/api/globals/another",
      "baz": "qux",
    }
  ],
}

Global

GET /api/globals/{handle}

Gets a single global set’s variables.

{
  "data": {
    "handle": "global",
    "api_url": "http://example.com/api/globals/global",
    "foo": "bar",
  }
}

Users

GET /api/users

Get users.

{
  "data": [
    {
      "id": "1",
      "email": "[email protected]",
      "api_url": "http://example.com/api/users/1"
    }
  ],
  "links": {...},
  "meta": {...}
}

User

GET /api/users/{id}

Get a single user.

{
  "data": {
    "id": "1",
    "email": "[email protected]",
    "api_url": "http://example.com/api/users/1"
  }
}

Assets

GET /api/assets/{container}

Get a container’s asset data.

{
  "data": [
    {
      "id": "main::foo.jpg",
      "url": "/assets/foo.jpg",
      "api_url": "http://example.com/api/assets/main/foo.jpg"
    }
  ],
  "links": {...},
  "meta": {...}
}

Asset

GET /api/assets/{container}/{path}

Get a single asset’s data.

The path in the URL should be the relative path from the container’s root.

{
  "data": {
    "id": "main::foo.jpg",
    "url": "/assets/foo.jpg",
    "api_url": "http://example.com/api/assets/main/foo.jpg"
  }
}

Customizing Resources

By default the resources generally use the item’s Augmented data.

You are free to override the resource classes with your own, in turn letting you customize the responses.

In a service provider, use the map method to define the overriding resources:

use App\Http\Resources\CustomEntryResource;
use Statamic\Http\Resources\API\Resource;
use Statamic\Http\Resources\API\EntryResource;

class AppServiceProvider extends Provider
{
    public function boot()
    {
        Resource::map([
            EntryResource::class => CustomEntryResource::class,
        ]);
    }
}

<?php

namespace App\Http\Resources;

use Statamic\Http\Resources\API\EntryResource;

class CustomEntryResource extends EntryResource
{
    public function toArray($request)
    {
        return [
            'id' => $this->resource->id(),
            'title' => $this->resource->value('title'),
        ];
    }
}

Authentication

Coming soon. There are no native access tokens or other common authentication methods ready to use. Yet.