Requests

All API requests should be made to the /api/v2/ prefix, and will return the response in JSON format along with standard HTTP success or error status codes. For errors, we will also include additional details about what went wrong encoded in the response body. For example:

{
    "detail": "company is required"
}

HTTP Verbs

Revnue utilizes standard CRUD verbs for our web APIs:

Method	Description
`GET`	Request used for retrieving a resource
`POST`	Request used for creating a resource
`PUT`	Request used for updating a resource
`DELETE`	Request used for deleting a resource

HTTP Status Codes

The various HTTP status codes we might return are listed below:

Code	Title	Description
`200`	OK	The request was successful
`201`	Created	The resource was successfully created
`400`	Bad Request	Bad Request
`401`	Unauthorized	The API key is invalid or user is not authorized
`404`	Not found	The resource does not exist
`405`	Method Not Allowed	The HTTP method is not allowed
`429`	Too Many Requests	The rate limit was exceeded.
`50X`	Internal Server Error	An error occurred with our API endpoint