API Guide / API Reference / Record API / List Records by View
List Records by View

Use this API to retrieve the list of records by the given view ID. Set the ID as parameter and use the GET method to read the records that matched with the view criteria. The Response will have the same fields as the view you have created and there will be the record Id field, which is the unique ID of each record, used as a reference in other APIs.


URL

https://Witly.co/api/v2/{module name}/data?id={0}&page={1}&token={2}[&format={3}]


HTTP Method

GET


Request Body

Not required


Request Parameters

Parameter

Required

Description

module name

Yes

Module API name (Acquired from Module API call)

id

Yes

View Unique ID (Acquired from View List API call)

page

Yes

Page of the desired view starting from page 1 

token

Yes

Access token

format

Optional

Expected return format. The default is JSON. Values are JSON and XML. This parameter is optional.


Example Request

https://Witly.co/api/v2/customer/data?id=98d48bde-3a6c-4590-9d79-7c9a62ba903f&page=1&token=5c33446ac1c049049f9232cf296bdf10


Example Response

{

"Total Record": 63,

"Records": [

{

"id": "98d48bde-3a6c-4590-9d79-7c9a62ba903f",

"AutoNumber": "201700044",

"Customer Name": "Acme",

"Annual Revenue": 100000000,

"Customer Type": null,

"Last Modified By": "John Doe",

"Last Modified Date": "2017-12-23T20:49:19.917"

},

{

"id": "9b988632-2dfb-47d6-8b4b-72b46b73f598",

"AutoNumber": "201700045",

"Customer Name": "ABC Tech",

"Annual Revenue": 500000000,

"Customer Type": "Account",

"Last Modified By": "John Doe",

"Last Modified Date": "2017-12-23T20:48:04.2"

},

...

]

}


Last modified on Jan 23, 2018

© 2024 Witly