Endpoint Anatomy
There are only four different types of endpoint in the BOX API. This keeps them very easy to understand and makes your code easier to read.
HTTP Verb | Name | Description |
---|---|---|
POST | create-resource | Create one new instance of an entity |
GET | resource | Retrieve the identified instance of an entity |
GET | list-resources | List all instances of an entity |
PUT | set-attribute | Change the given attribute of an entity |
You only need to remember the three verbs shown in the table above, we don't use any others, again, keeping it simple to help you.
Examples
POST create-customer # This creates a new customer
GET customer/1 # Retrieve customer number one
GET list-customers # List all of your customers
Updated over 1 year ago