The Award Force API can be used for a number of purposes to help you manage your program. Below you'll find a list of options available to you. To learn more, see our comprehensive API documents.
Attachment
List attachments | Returns a list of attachments. |
Get attachment | Returns an attachment by its token. The response consists of all attachment fields. Files include a download link. |
Update attachment | Update an existing attachment. |
Delete attachment | Delete an existing attachment. |
Category
List categories | Returns a list of categories. |
Get category | Returns a category by its slug. The response consists of all category fields. Images include a download link. |
Create category | Create a new category. |
Update category | Update an existing category. |
Delete category | Delete an existing category. |
Upload category file | Upload a category image. |
Chapter
List chapters | Returns a list of chapters. |
Get chapter | Returns a chapter by its slug. The response consists of all chapter fields. |
Create chapter | Create a new chapter. |
Update chapter | Update an existing chapter. |
Delete chapter | Delete an existing chapter. |
Upload chapter file | Upload a chapter image. |
Entry
List entries | Returns a list of entries. |
Get entry | Returns an entry by its slug. The response consists of all entry fields including files, attachments, and contributors. Files include a download link. |
Create entry | Create a new entry. |
Update entry | Update an existing entry. |
Delete entry | Delete an existing entry. |
Upload entry file | Upload a file to an entry file field. |
Upload entry attachment | Upload an attachment to an entry by its tab. |
Tag entry | Add tags to an existing entry. |
Untag entry | Remove tags from an existing entry. |
Field
List fields | Returns a list of fields. |
File
Get file info | Returns files information by its token. |
Order
List orders | Returns a list of orders. |
Get order | Returns an order by its slug. |
List order items | Returns a list of items related to the given order. |
Update order | Update the billing information and the status of an existing order. |
Season
List seasons | Returns a list of seasons. |
Get season | Returns a season by its slug. The response consists of all season fields. |
User
List users | Returns a list of users. |
Get user by email | Returns a user by its email. The response consists of all user fields including files. Files include a download link. |
Get user by slug | Returns a user by its slug. The response consists of all user fields including files. Files include a download link. |
Create user | Create a new user. |
Update user |
Update an existing user. |
Delete user |
Delete an existing user |
Upload user file |
Upload a file to a user file field. |
Get auth token |
Returns an auth token for a given user. The response consists of a token that allows the user to log into the app using SSO. |