From dc49fad81a51d1f418ee4f1065bda7656635a8ab Mon Sep 17 00:00:00 2001 From: David Bomba Date: Thu, 31 Jan 2019 08:20:22 +1100 Subject: [PATCH] Update API docs (#2641) * fix permissions * Api update --- docs/api.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index b8b698b87b65..c0370c88bb77 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -27,15 +27,13 @@ For invoices, quotes, tasks and payments simply change the object type. curl -X GET "ninja.test/api/v1/invoices" -H "X-Ninja-Token: TOKEN" -You can search clients by their email address or id number and invoices by their invoice number, status and type. (Check `Constants.php `_ for valid values of status and type.) +You can search clients by their email address or id number and invoices by their invoice number. .. code-block:: shell curl -X GET "ninja.test/api/v1/clients?email=" -H "X-Ninja-Token: TOKEN" curl -X GET "ninja.test/api/v1/clients?id_number=" -H "X-Ninja-Token: TOKEN" curl -X GET "ninja.test/api/v1/invoices?invoice_number=" -H "X-Ninja-Token: TOKEN" - curl -X GET "ninja.test/api/v1/invoices?status_id=" -H "X-Ninja-Token: TOKEN" - curl -X GET "ninja.test/api/v1/invoices?invoice_type_id=" -H "X-Ninja-Token: TOKEN" To load a single record specify the Id in the URL.