This API endpoint requires the Plus version of Sonoran CAD or higher. For more information, see our pricing page.
API response times may be increased slightly for communities with Database Sync enabled, depending upon the speed, latency and size of your in-game database.
Lookup By Value
POST https://api.sonorancad.com/general/lookup_custom
The lookup name endpoint allows you to retrieve all records associated with a specific value.
Request Body
200 A successful call will be met with the following response: Detailed contents of the record type arrays can be found further below.
API Call Example
Map
Record Types
Response Object Types
The search map is the unique Custom Record Field ID used in your custom search type. Record TypeThe record “type” is an enumerator used to distinguish the category of the custom record/report. These integer values are entered as an array in the types field of the lookup call.The characters object array will always be included with the search. The types filtering only applies to the custom records being returned. Response Object TypesRecords FormattingAll record results are returned in an object array. For more information on custom record structuring, see the documentation below: