Fork API

The Fork API allows anyone to build their own programs using the data in Fork.

Basics

The Fork API is a REST-style api.

[..]

Possible methods

Core

core.getAPIKey

Get the API-key for a user.

Parameters

email string
The email address for the user.
password string
The password for the user.

Return

An array with the public- and private key.

core.getInfo

Get info about the site.

Return

An array with the information about the site/language.

core.apple.addDevice

Add a device to a user.

Parameters

token string
The token of the device.

core.apple.removeDevice

Remove a device from a user.

Parameters

token string
The token of the device.

Blog

blog.comments.delete

Delete multiple comments at once.

Parameters

id string
The id/ids of the comment(s) to update.

blog.comments.get

Get the comments.

Parameters

status string (optional)
The type of comments to get. Possible values are: published, moderation, spam.
limit int (optional)
The maximum number of items to retrieve.
offset int (optional)
The offset.

Return

An array with the comments

blog.comments.getById

Get a single comment.

Parameters

id int
The id of the comment.

Return

An array with the comment

blog.comments.update

Update a comment

Parameters

id int
The id of the comment.
status string (optional)
The new status for the comment. Possible values are: published, moderation, spam.
text string (optional)
The new text for the comment.
authorName string (optional)
The new author for the comment.
authorEmail string (optional)
The new email for the comment.
authorWebsite string (optional)
The new website for the comment.

blog.comments.updateStatus

Update the status for multiple comments at once.

Parameters

id array
The id/ids of the comment(s) to update.
status string
The new status for the comment. Possible values are: published, moderation, spam.

FormBuilder

form_builder.getAll

Get a list of all the forms

Parameters

limit int (optional)
The maximum number of items to retrieve.
offset int (optional)
The offset.

Return

An array with the forms.

form_builder.entries.delete

Get a list of all the forms

Parameters

id int (optional)
The id of the entry.

Return

An array with the forms.

form_builder.entries.get

Get the list of entries for a form

Parameters

id int (optional)
The id of the form.
limit int (optional)
The maximum number of items to retrieve.
offset int (optional)
The offset.

Return

An array with the forms.

form_builder.entries.getById

Get a single entry

Parameters

id int (optional)
The id of the entry.

Return

An array with the data of the entry.