Warning:

This is a draft version of the documentation. A fullly featured and covered documentation will be released prior to the offical stable release of the system.

Introduction

Welcome to the official documentation of the Amaranth CRM API.

You will be able to learn and understand how our API works, how to authenticate , what are our endpoints and what responses you can receive, what will undoubtedly help you with debugging your integration.

Authentication

To use all endpoints you need to authenticate using your API token.

To generate your API token please visit tokens section of your account settings and click "Generate". Please remember - you will always be able to find your token there, but be aware you won't be able to re-generate it again, so please keep it safe as we do reserve the right to block temporally or permanently any token used in requests acting against our Terms and Conditions.

User

Method Endpoint Description
GET /user/all Returns list of all users in a company
GET /user/find/by:{field},{value} Returns the results of a query based on {field} and {value}
GET /user/{user} Returns details of a specific user
PUT /user/{user} Updates a specific user
POST /user Creates a new user

Company

Method Endpoint Description
GET /company Returns list of all users in a company
GET /company/customers Returns list of all customers under your company
GET /company/invoices Returns list of all invoices under your company
GET /company/payments Returns list of all payments under your company
GET /company/estimates Returns list of all estimates under your company
PUT /company Updates your company

Customer

Method Endpoint Description
GET /customer/all Returns list of all company's customers
GET /customer/{id} Returns details of a specific customer
GET /customer/{id}/invoices Returns list of all invoices under a specific customer
GET /customer/{id}/payments Returns list of all payments under a specific customer
GET /customer/{id}/estimates Returns list of all estimates under a specific customer
PUT /customer/{id} Updates customer
POST /customer Creates customer
DELETE /customer/{id} Deletes customer

Invoice

Method Endpoint Description
GET /invoice/all Returns list of all invoices under your company
GET /invoice/{customer}/all Returns list of all invoices under a specific customer of your company
GET /invoice/find/by:{field},{value} Returns the results of a query based on {field} and {value}
GET /invoice/{id} Returns details of a specific user
PUT /invoice/{id} Updates a specific invoice
POST /invoice Creates a new invoice

Payment

Estimate

Project

Report

Expense

Rate Limiting

Migration

Contact & Support

We try to make this documentation as simple and accessible as possible. However, we do understand that technical terms and aspects can be difficult and may often lead to misstatements or not provide all information needed. Therefore, when you should have any further questions or need an explaination of anything mentioned in this document, please do not hesitate to give us a shout, as we encourage all our partners to do so, in order to prevent service disruptions and errors on either side

The best way to contact us is to drop us an email at [email protected] or using our contact form.

We target to give you a first-off reply within 24 bussiness hours.