API Guide / API Reference / Record API / Search
Search

Use this API to search the records in Witly. You can define more than one condition in search. If this request is successful, the server returns a response body which contains the search result fields that include the record ID, which is a unique ID of each record, and the key fields of each module.


URL

https://Witly.co/api/v2/{module name}/search?{field=value}&token{0}={1}[&format={2}]


HTTP Method

GET


Request Body

Not required


Request Parameters

Parameter

Required

Description

module name

Yes

Module API name (Acquired from Module API call)

field

Yes

Search conditions. Supports multiple filters.

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/search?token=5c33446ac1c049049f9232cf296bdf10

&customer name=acme&customer type=account


Example Response

{

"Search Count"11,

"Search Results": [

{

"id""14af6901-4e63-4aff-ad8a-25e7d0ed9645",

"AutoNumber""201700019"

},

{

"id""96cd690f-86b9-40ec-ab3e-991e0251b799",

"AutoNumber""201700022"

}

]

}


Last modified on Jan 23, 2018