Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-07-09 03:14:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

Working on docs

Browse Source
This commit is contained in:
Hillel Coren 2017-03-13 21:14:17 +02:00
parent b43ffc4c92
commit 5ab36beedd
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api.rst
View File

@ -55,12 +55,12 @@ Optional Settings
The following are optional query parameter settings:
- serializer: Either array (the default) or json. If json is selected the data is returned using the `JSON API <http://jsonapi.org/>`_ format.
- include: A comma-separated list of nested relationships to include.
- client_id: If set the results will be filtered by the client.
- page: The page number of results to return when the results are paginated.
- per_page: The number of results to return per page.
- updated_at: Timestamp used as a filter to only show recently updated records.
- **serializer**: Either array (the default) or json. If json is selected the data is returned using the `JSON API <http://jsonapi.org/>`_ format.
- **include**: A comma-separated list of nested relationships to include.
- **client_id**: If set the results will be filtered by the client.
- **page**: The page number of results to return when the results are paginated.
- **per_page**: The number of results to return per page.
- **updated_at**: Timestamp used as a filter to only show recently updated records.
Subscriptions
"""""""""""""