Switch branches/tags
4.9.57.p 4.9.57.p-sans-tests-tag 4.9.56.p 4.9.56.p-sans-tests-tag 4.9.55.p 4.9.55.p-sans-tests-tag 4.9.54.p 4.9.54.p-sans-tests-tag 4.9.53.p 4.9.53.p-sans-tests-tag 4.9.52.p 4.9.52.p-sans-tests-tag 4.9.51.p 4.9.51.p-sans-tests-tag 4.9.50.p 4.9.50.p-sans-tests-tag 4.9.49.p 4.9.49.p-sans-tests-tag 4.9.48.p 4.9.48.p-sans-tests-tag 4.9.47.p 4.9.47.p-sans-tests-tag 4.9.46.p 4.9.46.p-sans-tests-tag 4.9.45.p 4.9.45.p-sans-tests-tag 4.9.44.p 4.9.44.p-sans-tests-tag 4.9.43.p 4.9.43.p-sans-tests-tag 4.9.42.p 4.9.42.p-sans-tests-tag 4.9.41.p 4.9.41.p-sans-tests-tag 4.9.40.p 4.9.40.p-sans-tests-tag 4.9.39.p 4.9.39.p-sans-tests-tag 4.9.38.p 4.9.38.p-sans-tests-tag 4.9.37.p 4.9.37.p-sans-tests-tag 4.9.36.p 4.9.36.p-sans-tests-tag 4.9.35.p 4.9.35.p-sans-tests-tag 4.9.34.p 4.9.34.p-sans-tests-tag 4.9.33.p 4.9.33.p-sans-tests-tag 4.9.32.p 4.9.32.p-sans-tests-tag 4.9.31.p 4.9.31.p-sans-tests-tag 4.9.30.p 4.9.30.p-sans-tests-tag 4.9.29.p 4.9.29.p-sans-tests-tag 4.9.28.p 4.9.28.p-sans-tests-tag 4.9.27.p 4.9.27.p-sans-tests-tag 4.9.26.p 4.9.26.p-sans-tests-tag 4.9.25.p 4.9.25.p-sans-tests-tag 4.9.24.p 4.9.24.p-sans-tests-tag 4.9.23.p 4.9.23.p-sans-tests-tag 4.9.22.p 4.9.22.p-sans-tests-tag 4.9.21.p 4.9.21.p-sans-tests-tag 4.9.20.p 4.9.20.p-sans-tests-tag 4.9.19.p 4.9.19.p-sans-tests-tag 4.9.18.p 4.9.18.p-sans-tests-tag 4.9.17.p 4.9.17.p-sans-tests-tag 4.9.16.p 4.9.16.p-sans-tests-tag 4.9.15.p 4.9.15.p-sans-tests-tag 4.9.14.p 4.9.14.p-sans-tests-tag 4.9.13.p 4.9.13.p-sans-tests-tag 4.9.12.p 4.9.12.p-sans-tests-tag 4.9.11.p 4.9.11.p-sans-tests-tag 4.9.10.p 4.9.10.p-sans-tests-tag 4.9.9.p 4.9.9.p-sans-tests-tag 4.9.8.p 4.9.8.p-sans-tests-tag
Nothing to show
Find file History
Permalink
..
Failed to load latest commit information.
eejs-api flesh out documnentation for authentication [touch: 10509] Feb 28, 2017
README.md Revert "[touch:9222]{t:30}revert merging of 9222 into master. I reali… May 12, 2017
ee4-rest-api-GET-calculated-fields.md add more rest api docs Mar 27, 2016
ee4-rest-api-GET-filtering-results.md Fix code block formatting Jul 7, 2017
ee4-rest-api-GET-including-specific-fields-and-related-entities-in-results.md Fix formatting and bump version number in examples Jul 7, 2017
ee4-rest-api-GET-response-headers.md add more rest api docs Mar 27, 2016
ee4-rest-api-calculated-fields-reference.md Fix URLs in REST API calculated fields reference Nov 22, 2016
ee4-rest-api-introduction.md Revert "[touch:9222]{t:30}revert merging of 9222 into master. I reali… May 12, 2017
ee4-rest-api-reading-data.md [touch:9222]{t:90}when fetching data from the DB that is a serialized… May 18, 2017
ee4-rest-api-rpc-checkin.md [touch:10556]{t:15}update checkin endpoint documentation Mar 23, 2017
ee4-rest-api-rpc-style-endpoints.md add rpc introduction and checkin rpc (ee4 rest api) doc Mar 27, 2016
ee4-rest-api-schema.md add documentation about schema [touch: 10330] Jan 15, 2017
ee4-rest-api-testing-tools.md add api testing tools doc Mar 27, 2016
ee4-rest-api-writing-data.md Revert "[touch:9222]{t:30}revert merging of 9222 into master. I reali… May 12, 2017
rest-api-changelog.md [touch:9222]{t:10}add the removal of post_metas to the rest api chang… May 23, 2017

README.md

The documents in this folder are all related to the REST API in EE core.

Table of Contents

GET Requests

Schema

RPC Style Endpoints

There are a few endpoints in the EE4 REST API that really don't follow the REST way of doing things, and are more like RPC (Remote Procedure Calls). These endpoints aren't just for simple reading, inserting, updating, or deleting. They have a bunch of other logic tied in there, which can sometimes be handy, so that your application doesn't need to implement all this logic itself (of course if you don't want all this extra logic, you're welcome to use the more traditional RESTy read and writing endpoints instead).

Write Endpoints

Libraries/Tools

There are some handy libraries and tools that have been built that integrate with the REST API.

Library Description
eejs-api (VUE.js library) When implemented you can use this to automatically build EE model and collection components that can be used in your views.

Related Tutorials

Don't miss the REST API tutorials in our tutorials section.