Add endpoint docs to Item

ECN · Apr 4, 2021 · e1bea81 · e1bea81
1 parent 897a976
commit e1bea81
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/docs/api/Items.md b/docs/api/Items.md
@@ -2,6 +2,28 @@
 
 An item is a chronological representation of an interaction with a user.
 
+## Endpoint
+```
+GET /api/{queue}/{number}
+```
+### Parameters
+Name | Value
+- | -
+`queue` | The queue of the item.
+`number` | The number of the item.
+
+### Query String Options
+Name | Description | Possible Values
+- | - | -
+`headersOnly` | When `"True"`, only meta data will be loaded. When `"False"` content will be parsed. (Defaults to `"False"`.) | `"True"` \| `"False"`
+
+### Return Codes
+Code | Description
+- | -
+`200 - Ok` | On success.
+`500 - Internal Service Error` | On failure.
+
+
 ## Properties
 
 ### `Item.lastUpdated`