The judyrecords API is divided into two parts:
\nThe Structured Objects API allows searching and retrieving data using finer-grained data fields (e.g., case name, case number, party name, etc.).
\nThe Full-Text API allows searching the text within cases similar to searching Google for keywords and phrases within the web pages it's crawled.
\nThe API is a RESTful API based on HTTP requests and JSON responses. This version of the API uses an API key. This means that requests will need to include your API key as an HTTP header or query string parameter.
\nThe easiest way to start using the API is by clicking the Run in Postman button at the top-right of this page.
\nPostman is a free tool for running and testing pre-built API requests. The pre-built API requests, together with the example requests/responses and corresponding documentation, are referred to as a \"Postman collection\".
\nIn the judyrecords Postman collection, the pre-built API requests are organized into the folders on the left.
\nFor API inquiries, contact api@judyrecords.com.
\nClick the Environment quick look icon in the upper-right hand corner of Postman. Then click Add in the Globals (global variables) section.
The Globals tab will display allowing you to add your API key as a global variable. Add a variable with the name X-Api-Key. Then, paste your API key in the Current value column.
Once the global variable has been added, click the Save icon to save the global variable.
Your API key and value will now show up in the Environment quick look dialog.
You can now make requests to the judyrecords API. All Postman collection requests automatically include the X-Api-Key as a header.
Note: You may also add your API key as a URL parameter. However, this is intended for convenience and should not be used in production.
\nTo start, let's make a sample request to the judyrecords API. The sample request will output a JSON response containing \"Hello, World!\" as a greeting.
\nIf a valid API key is used, the greeting will be returned as shown in Example 1 - Success. Otherwise, a response containing an error will be returned as shown in Example 2 - Failure.
Use the examples dropdown for this request and throughout the Postman collection to easily view request/response examples.
\nAdditionally, keep in mind that you can select your preferred language from the language selector above to customize the pre-built sample requests and responses. You may also choose to display the pre-built sample requests using plain HTTP or curl-based commands.
\nThis search request uses Elasticsearch's _search API, and the special index _all is used to query all indexes. The offset (0) and limit (3) are specified using the from and size fields in the request body. For more information on the from and size parameters, see here. For information about the response body format, see here.
The example request/response shows 3 cases returned from the search. Since there was no additional filteria criteria, 3 arbitrary cases may be returned (similar to an SQL SELECT with a LIMIT clause but without a WHERE clause).
\n","urlObject":{"protocol":"https","path":["api","structured-objects","_all","_search"],"host":["{{judyrecordsHost}}"],"query":[],"variable":[]}},"response":[{"id":"12ab0469-4b8b-4050-853c-2ff36190ab43","name":"Example 1 - Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"from\": 0,\r\n \"size\": 3\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{judyrecordsHost}}/api/structured-objects/_all/_search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 02:56:35 GMT"},{"key":"Server","value":"Apache"},{"key":"X-elastic-product","value":"Elasticsearch"},{"key":"Warning","value":"299 Elasticsearch-7.17.16-2b23fa076334f8d4651aeebe458a955a2ae23218 \"Elasticsearch built-in security features are not enabled. Without authentication, your cluster could be accessible to anyone. See https://www.elastic.co/guide/en/elasticsearch/reference/7.17/security-minimal-setup.html to enable security.\""},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"770"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"took\": 43,\n \"timed_out\": false,\n \"_shards\": {\n \"total\": 438,\n \"successful\": 438,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"hits\": {\n \"total\": {\n \"value\": 10000,\n \"relation\": \"gte\"\n },\n \"max_score\": 1,\n \"hits\": [\n {\n \"_index\": \"normalized_parsed_alaska\",\n \"_type\": \"_doc\",\n \"_id\": \"8_1400001\",\n \"_score\": 1,\n \"_source\": {\n \"dataSourceId\": \"8\",\n \"caseId\": 1400001,\n \"urlId\": \"1b0kk0279c01\",\n \"dataSourceName\": \"Alaska - Statewide Court Records\",\n \"dataSourceGeoCountry\": \"United States\",\n \"dataSourceGeoRegion\": \"Alaska\",\n \"dataSourceGeoDistrict\": null,\n \"courtId\": 3210,\n \"courtName\": \"United States, Alaska, Trial Court System\",\n \"caseNumber\": \"3PA-02-00480MO\",\n \"caseNumberNormalized\": \"3PA0200480MO\",\n \"caseName\": null,\n \"caseType\": \"MINOR OFFENSES (3PA)\",\n \"caseStatus\": \"CLOSED\",\n \"dateFiled\": \"2002-08-16\",\n \"parties\": [\n {\n \"partyName\": \"Campbell, JR , Gregory Scott\",\n \"partyRole\": \"DEFENDANT\",\n \"dateOfBirthYear\": 1981,\n \"dateOfBirthMonth\": 10,\n \"dateOfBirthDay\": 12,\n \"aliases\": []\n },\n {\n \"partyName\": \"State of Alaska\",\n \"partyRole\": \"PROSECUTION\",\n \"dateOfBirthYear\": null,\n \"dateOfBirthMonth\": null,\n \"dateOfBirthDay\": null,\n \"aliases\": []\n }\n ]\n }\n },\n {\n \"_index\": \"normalized_parsed_alaska\",\n \"_type\": \"_doc\",\n \"_id\": \"8_1400002\",\n \"_score\": 1,\n \"_source\": {\n \"dataSourceId\": \"8\",\n \"caseId\": 1400002,\n \"urlId\": \"1b01vc6x3325\",\n \"dataSourceName\": \"Alaska - Statewide Court Records\",\n \"dataSourceGeoCountry\": \"United States\",\n \"dataSourceGeoRegion\": \"Alaska\",\n \"dataSourceGeoDistrict\": null,\n \"courtId\": 3210,\n \"courtName\": \"United States, Alaska, Trial Court System\",\n \"caseNumber\": \"3AN-01-04601SC\",\n \"caseNumberNormalized\": \"3AN0104601SC\",\n \"caseName\": null,\n \"caseType\": \"SMALL CLAIMS (3AN)\",\n \"caseStatus\": \"CLOSED\",\n \"dateFiled\": \"2001-11-28\",\n \"parties\": [\n {\n \"partyName\": \"PARK FORREST CONDO\",\n \"partyRole\": \"PLAINTIFF\",\n \"dateOfBirthYear\": null,\n \"dateOfBirthMonth\": null,\n \"dateOfBirthDay\": null,\n \"aliases\": []\n },\n {\n \"partyName\": \"Campoamor, Gilbert\",\n \"partyRole\": \"DEFENDANT\",\n \"dateOfBirthYear\": null,\n \"dateOfBirthMonth\": null,\n \"dateOfBirthDay\": null,\n \"aliases\": []\n },\n {\n \"partyName\": \"Campoarmor, Kathy\",\n \"partyRole\": \"DEFENDANT\",\n \"dateOfBirthYear\": null,\n \"dateOfBirthMonth\": null,\n \"dateOfBirthDay\": null,\n \"aliases\": []\n }\n ]\n }\n },\n {\n \"_index\": \"normalized_parsed_alaska\",\n \"_type\": \"_doc\",\n \"_id\": \"8_1400003\",\n \"_score\": 1,\n \"_source\": {\n \"dataSourceId\": \"8\",\n \"caseId\": 1400003,\n \"urlId\": \"1b01moyk3486\",\n \"dataSourceName\": \"Alaska - Statewide Court Records\",\n \"dataSourceGeoCountry\": \"United States\",\n \"dataSourceGeoRegion\": \"Alaska\",\n \"dataSourceGeoDistrict\": null,\n \"courtId\": 3210,\n \"courtName\": \"United States, Alaska, Trial Court System\",\n \"caseNumber\": \"3AN-02-01777CR\",\n \"caseNumberNormalized\": \"3AN0201777CR\",\n \"caseName\": null,\n \"caseType\": \"CRIM DIST CT MISD (3AN)\",\n \"caseStatus\": \"CLOSED\",\n \"dateFiled\": \"2002-02-27\",\n \"parties\": [\n {\n \"partyName\": \"Cannon, Gabriel Lucius\",\n \"partyRole\": \"DEFENDANT\",\n \"dateOfBirthYear\": 1973,\n \"dateOfBirthMonth\": 4,\n \"dateOfBirthDay\": 12,\n \"aliases\": []\n },\n {\n \"partyName\": \"Municipality of Anchorage\",\n \"partyRole\": \"PROSECUTION\",\n \"dateOfBirthYear\": null,\n \"dateOfBirthMonth\": null,\n \"dateOfBirthDay\": null,\n \"aliases\": []\n }\n ]\n }\n }\n ]\n }\n}"}],"_postman_id":"9af3bd63-a70f-474a-8f8b-bd0ba897a240"},{"name":"Basic search request, filter by data source name","id":"10956bee-1cee-48e7-9a61-47ec6ec4c52c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"from\": 0,\r\n \"size\": 3,\r\n \"query\": {\r\n \"match\": {\r\n \"dataSourceName\": \"texas\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{judyrecordsHost}}/api/structured-objects/_all/_search","description":"This search request uses Elasticsearch's _search API, and the special index _all is used to query all indexes. The offset (0) and limit (3) are specified using the from and size fields in the request body. For more information on the from and size parameters, see here. For information about the response body format, see here.
To filter by data source name, a match query is used with the dataSourceName field and the value \"texas\". For info about the match query syntax, see here.
\n","urlObject":{"protocol":"https","path":["api","structured-objects","_all","_search"],"host":["{{judyrecordsHost}}"],"query":[],"variable":[]}},"response":[{"id":"b2946fa4-9246-4709-88ec-56bfdd000da5","name":"Example 1 - Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"from\": 0,\r\n \"size\": 3,\r\n \"query\": {\r\n \"match\": {\r\n \"dataSourceName\": \"texas\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{judyrecordsHost}}/api/structured-objects/_all/_search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 04:09:43 GMT"},{"key":"Server","value":"Apache"},{"key":"X-elastic-product","value":"Elasticsearch"},{"key":"Warning","value":"299 Elasticsearch-7.17.16-2b23fa076334f8d4651aeebe458a955a2ae23218 \"Elasticsearch built-in security features are not enabled. Without authentication, your cluster could be accessible to anyone. See https://www.elastic.co/guide/en/elasticsearch/reference/7.17/security-minimal-setup.html to enable security.\""},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"628"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"took\": 29,\n \"timed_out\": false,\n \"_shards\": {\n \"total\": 438,\n \"successful\": 438,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"hits\": {\n \"total\": {\n \"value\": 10000,\n \"relation\": \"gte\"\n },\n \"max_score\": 0.00005081946,\n \"hits\": [\n {\n \"_index\": \"normalized_parsed_jailtexascopanolav2\",\n \"_type\": \"_doc\",\n \"_id\": \"753_1\",\n \"_score\": 0.00005081946,\n \"_source\": {\n \"dataSourceId\": \"753\",\n \"caseId\": 1,\n \"urlId\": \"jk2a8718\",\n \"dataSourceName\": \"Panola County, Texas - Jail Records\",\n \"dataSourceGeoCountry\": \"United States\",\n \"dataSourceGeoRegion\": \"Texas\",\n \"dataSourceGeoDistrict\": \"Panola County\",\n \"courtId\": null,\n \"courtName\": null,\n \"caseNumber\": \"14-0464\",\n \"caseNumberNormalized\": \"140464\",\n \"caseName\": \"Booking of: ANDREWS, AMANDA NICOLE\",\n \"caseType\": \"JAILING\",\n \"caseStatus\": null,\n \"dateFiled\": \"2014-04-25\",\n \"parties\": [\n {\n \"partyName\": \"ANDREWS, AMANDA NICOLE\",\n \"partyRole\": \"DEFENDANT\",\n \"dateOfBirthYear\": null,\n \"dateOfBirthMonth\": null,\n \"dateOfBirthDay\": null,\n \"aliases\": []\n }\n ]\n }\n },\n {\n \"_index\": \"normalized_parsed_jailtexascopanolav2\",\n \"_type\": \"_doc\",\n \"_id\": \"753_2\",\n \"_score\": 0.00005081946,\n \"_source\": {\n \"dataSourceId\": \"753\",\n \"caseId\": 2,\n \"urlId\": \"v2b614b0a\",\n \"dataSourceName\": \"Panola County, Texas - Jail Records\",\n \"dataSourceGeoCountry\": \"United States\",\n \"dataSourceGeoRegion\": \"Texas\",\n \"dataSourceGeoDistrict\": \"Panola County\",\n \"courtId\": null,\n \"courtName\": null,\n \"caseNumber\": \"14-0666\",\n \"caseNumberNormalized\": \"140666\",\n \"caseName\": \"Booking of: GRIFFIN, AMANDA JEAN\",\n \"caseType\": \"JAILING\",\n \"caseStatus\": null,\n \"dateFiled\": \"2014-06-11\",\n \"parties\": [\n {\n \"partyName\": \"GRIFFIN, AMANDA JEAN\",\n \"partyRole\": \"DEFENDANT\",\n \"dateOfBirthYear\": null,\n \"dateOfBirthMonth\": null,\n \"dateOfBirthDay\": null,\n \"aliases\": [\n {\n \"aliasName\": \"GRIFFIN, AMANDA\"\n },\n {\n \"aliasName\": \"HALL, AMANDA KENESON\"\n },\n {\n \"aliasName\": \"KENESON, AMANDA JEAN\"\n }\n ]\n }\n ]\n }\n },\n {\n \"_index\": \"normalized_parsed_jailtexascopanolav2\",\n \"_type\": \"_doc\",\n \"_id\": \"753_3\",\n \"_score\": 0.00005081946,\n \"_source\": {\n \"dataSourceId\": \"753\",\n \"caseId\": 3,\n \"urlId\": \"v6lyqfaf6\",\n \"dataSourceName\": \"Panola County, Texas - Jail Records\",\n \"dataSourceGeoCountry\": \"United States\",\n \"dataSourceGeoRegion\": \"Texas\",\n \"dataSourceGeoDistrict\": \"Panola County\",\n \"courtId\": null,\n \"courtName\": null,\n \"caseNumber\": \"14-0844\",\n \"caseNumberNormalized\": \"140844\",\n \"caseName\": \"Booking of: ARMIE, ANDREW WILLIAM\",\n \"caseType\": \"JAILING\",\n \"caseStatus\": null,\n \"dateFiled\": \"2014-07-26\",\n \"parties\": [\n {\n \"partyName\": \"ARMIE, ANDREW WILLIAM\",\n \"partyRole\": \"DEFENDANT\",\n \"dateOfBirthYear\": null,\n \"dateOfBirthMonth\": null,\n \"dateOfBirthDay\": null,\n \"aliases\": []\n }\n ]\n }\n }\n ]\n }\n}"}],"_postman_id":"10956bee-1cee-48e7-9a61-47ec6ec4c52c"},{"name":"Review an index mapping","id":"d397ddf7-1720-429c-995c-0e09bb097883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{judyrecordsHost}}/api/structured-objects/:mapping/_mapping","description":"To formulate search queries, it's important to understand the mapping used for an index. A mapping defines the fields available, their corresponding data types, and index-time settings that determine how the index can be searched.
\nTo get the mapping for an index, the following request specifies the mapping as a URL path segment, followed by _mapping. For information about Elasticsearch mapping, see here.
Although there are many indexes, they can be expected to share the same core mapping. A possible reason index mappings may differ is to support the addition of new functionality through new fields in a backwards-compatible way. Non-backward-compatible changes may occur as part of a slower-running, planned process to make improvements to the API that would otherwise not be possible with fully backwards-compatible changes.
\n","urlObject":{"protocol":"https","path":["api","structured-objects",":mapping","_mapping"],"host":["{{judyrecordsHost}}"],"query":[],"variable":[{"type":"any","value":"normalized_parsed_jailtexascopanolav2","key":"mapping"}]}},"response":[{"id":"eb8a17cb-a704-447c-a2ab-8ccf6985a001","name":"Example 1 - Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{judyrecordsHost}}/api/structured-objects/:mapping/_mapping","protocol":"https","host":["{{judyrecordsHost}}"],"path":["api","structured-objects",":mapping","_mapping"],"variable":[{"key":"mapping","value":"normalized_parsed_jailtexascopanolav2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 04:40:26 GMT"},{"key":"Server","value":"Apache"},{"key":"X-elastic-product","value":"Elasticsearch"},{"key":"Warning","value":"299 Elasticsearch-7.17.16-2b23fa076334f8d4651aeebe458a955a2ae23218 \"Elasticsearch built-in security features are not enabled. Without authentication, your cluster could be accessible to anyone. See https://www.elastic.co/guide/en/elasticsearch/reference/7.17/security-minimal-setup.html to enable security.\""},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"384"},{"key":"Keep-Alive","value":"timeout=5, max=249"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"normalized_parsed_jailtexascopanolav2\": {\n \"mappings\": {\n \"dynamic\": \"false\",\n \"properties\": {\n \"caseId\": {\n \"type\": \"keyword\",\n \"index\": false,\n \"doc_values\": false\n },\n \"caseName\": {\n \"type\": \"text\"\n },\n \"caseNumber\": {\n \"type\": \"text\"\n },\n \"caseNumberNormalized\": {\n \"type\": \"keyword\"\n },\n \"caseStatus\": {\n \"type\": \"text\",\n \"fields\": {\n \"keyword\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"caseType\": {\n \"type\": \"text\",\n \"fields\": {\n \"keyword\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"courtId\": {\n \"type\": \"keyword\",\n \"index\": false,\n \"doc_values\": false\n },\n \"courtName\": {\n \"type\": \"text\",\n \"fields\": {\n \"keyword\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"dataSourceGeoCountry\": {\n \"type\": \"text\",\n \"fields\": {\n \"keyword\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"dataSourceGeoDistrict\": {\n \"type\": \"text\",\n \"fields\": {\n \"keyword\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"dataSourceGeoRegion\": {\n \"type\": \"text\",\n \"fields\": {\n \"keyword\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"dataSourceId\": {\n \"type\": \"constant_keyword\",\n \"value\": \"753\"\n },\n \"dataSourceName\": {\n \"type\": \"text\",\n \"fields\": {\n \"keyword\": {\n \"type\": \"constant_keyword\",\n \"value\": \"Panola County, Texas - Jail Records\"\n }\n }\n },\n \"dateFiled\": {\n \"type\": \"date\",\n \"format\": \"yyyy-MM-dd\"\n },\n \"parties\": {\n \"type\": \"nested\",\n \"dynamic\": \"false\",\n \"properties\": {\n \"aliases\": {\n \"type\": \"nested\",\n \"dynamic\": \"false\",\n \"properties\": {\n \"aliasName\": {\n \"type\": \"text\"\n }\n }\n },\n \"dateOfBirthDay\": {\n \"type\": \"byte\"\n },\n \"dateOfBirthMonth\": {\n \"type\": \"byte\"\n },\n \"dateOfBirthYear\": {\n \"type\": \"short\"\n },\n \"partyName\": {\n \"type\": \"text\",\n \"fields\": {\n \"keyword\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"partyRole\": {\n \"type\": \"text\",\n \"fields\": {\n \"keyword\": {\n \"type\": \"keyword\"\n }\n }\n }\n }\n },\n \"urlId\": {\n \"type\": \"keyword\",\n \"index\": false,\n \"doc_values\": false\n }\n }\n }\n }\n}"}],"_postman_id":"d397ddf7-1720-429c-995c-0e09bb097883"},{"name":"Retrieve a case","id":"9879d0c1-c852-4e51-bda3-57b5d1d05125","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{judyrecordsHost}}/api/structured-objects/get-case/:dataSourceId/:caseId","description":"To retrieve a case, a request to the get-case endpoint is made with the dataSourceId and caseId as URL path segment parameters.
Adds a search by party job for an individual, using first name, last name, and optionally middle name.
\n","urlObject":{"protocol":"https","path":["api","structured-objects","{{client}}","add-search-by-party-job"],"host":["{{judyrecordsHost}}"],"query":[{"key":"search[partyType]","value":"individual"},{"key":"search[firstName]","value":"andrew"},{"key":"search[middleNameOrInitial]","value":"l"},{"key":"search[lastName]","value":"buxton"},{"disabled":true,"description":{"content":"Full name of state or two-letter state abbreviation.
\n","type":"text/plain"},"key":"search[state]","value":"Massachusetts"},{"disabled":true,"key":"search[dateFiledStartDate]","value":"2000-01-01"},{"disabled":true,"key":"search[dateFiledEndDate]","value":"2026-12-31"},{"description":{"content":"Applicable if full middle name provided. If set to no, parties where only the middle initial is available and matches are included.
\n","type":"text/plain"},"key":"search[excludePossibleMatchesMatchingMiddleInitialOnly]","value":"no"},{"key":"search[excludePossibleMatchesMatchingFirstAndLastNameOnly]","value":"no"},{"description":{"content":"Applicable if full middle name or middle initial provided. If set to no, parties where only the first and last name is available and matches are included.
\n","type":"text/plain"},"key":"search[limit]","value":"2000"},{"disabled":true,"description":{"content":"A deduplication key may be provided based on agreed terms that allows recognizing multiple searches as a single billable unit.
\n","type":"text/plain"},"key":"deduplicationKey","value":""}],"variable":[]}},"response":[{"id":"0b67b0bc-c48f-46d1-9277-5a222edc272e","name":"Example 1 - Success","originalRequest":{"method":"POST","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{judyrecordsHost}}/api/structured-objects/{{client}}/add-search-by-party-job?search[partyType]=individual&search[firstName]=andrew&search[middleNameOrInitial]=l&search[lastName]=buxton&search[excludePossibleMatchesMatchingMiddleInitialOnly]=no&search[excludePossibleMatchesMatchingFirstAndLastNameOnly]=no&search[limit]=2000&deduplicationKey=","protocol":"https","host":["{{judyrecordsHost}}"],"path":["api","structured-objects","{{client}}","add-search-by-party-job"],"query":[{"key":"search[partyType]","value":"individual"},{"key":"search[firstName]","value":"andrew"},{"key":"search[middleNameOrInitial]","value":"l"},{"key":"search[lastName]","value":"buxton"},{"key":"search[state]","value":"Massachusetts","disabled":true},{"key":"search[dateFiledStartDate]","value":"2000-01-01","disabled":true},{"key":"search[dateFiledEndDate]","value":"2026-12-31","disabled":true},{"key":"search[excludePossibleMatchesMatchingMiddleInitialOnly]","value":"no"},{"key":"search[excludePossibleMatchesMatchingFirstAndLastNameOnly]","value":"no"},{"key":"search[limit]","value":"2000"},{"key":"deduplicationKey","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 31 Mar 2026 05:54:56 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"93"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"data\": {\n \"searchJobId\": \"01KN17B6QT09NK2XD26J4C3YSW\"\n }\n}"},{"id":"ccd3677c-a23a-47c0-9b86-951a33508f69","name":"Example 2 - Failed","originalRequest":{"method":"POST","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{judyrecordsHost}}/api/structured-objects/{{client}}/add-search-by-party-job?search[partyType]=individual&search[firstName]=&search[middleNameOrInitial]=l&search[lastName]=buxton&search[dateFiledStartDate]=2000-01-40&search[excludePossibleMatchesMatchingMiddleInitialOnly]=no&search[excludePossibleMatchesMatchingFirstAndLastNameOnly]=no&search[limit]=2000&deduplicationKey=","protocol":"https","host":["{{judyrecordsHost}}"],"path":["api","structured-objects","{{client}}","add-search-by-party-job"],"query":[{"key":"search[partyType]","value":"individual"},{"key":"search[firstName]","value":""},{"key":"search[middleNameOrInitial]","value":"l"},{"key":"search[lastName]","value":"buxton"},{"key":"search[state]","value":"Massachusetts","disabled":true},{"key":"search[dateFiledStartDate]","value":"2000-01-40"},{"key":"search[dateFiledEndDate]","value":"2026-12-31","disabled":true},{"key":"search[excludePossibleMatchesMatchingMiddleInitialOnly]","value":"no"},{"key":"search[excludePossibleMatchesMatchingFirstAndLastNameOnly]","value":"no"},{"key":"search[limit]","value":"2000"},{"key":"deduplicationKey","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 31 Mar 2026 06:09:25 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"147"},{"key":"Keep-Alive","value":"timeout=5, max=249"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"errors\": {\n \"search.name.firstName\": [\n \"First Name must not be blank.\"\n ],\n \"search.dateFiledStartDate\": [\n \"If provided, Date Filed Start Date must be a valid date.\"\n ]\n }\n}"}],"_postman_id":"0da0c8e1-3bcc-4f18-a095-476cf9577680"},{"name":"Step 1 - Add Search By Party Job - Organization","event":[{"listen":"test","script":{"id":"6cae2099-a25a-4cbc-8e29-a628a5ddefd1","exec":["const body = pm.response.json();\r","pm.globals.set('searchJobId', body.data.searchJobId);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"33bbdbc4-3ce5-49d2-8f91-4a0e2a907acb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{judyrecordsHost}}/api/structured-objects/{{client}}/add-search-by-party-job?search[partyType]=organization&search[orgName]=\"international business machines\" OR \"ibm\"&search[state]=Massachusetts&search[limit]=2000&deduplicationKey=","description":"Adds a search by party job for an organization, using a query string to search the organization.
\n","urlObject":{"protocol":"https","path":["api","structured-objects","{{client}}","add-search-by-party-job"],"host":["{{judyrecordsHost}}"],"query":[{"key":"search[partyType]","value":"organization"},{"description":{"content":"Specify a query string using keywords, exact phrases, and operators.
\n","type":"text/plain"},"key":"search[orgName]","value":"\"international business machines\" OR \"ibm\""},{"description":{"content":"Full name of state or two-letter state abbreviation.
\n","type":"text/plain"},"key":"search[state]","value":"Massachusetts"},{"disabled":true,"key":"search[dateFiledStartDate]","value":"2020-01-01"},{"disabled":true,"key":"search[dateFiledEndDate]","value":"2026-12-31"},{"key":"search[limit]","value":"2000"},{"description":{"content":"A deduplication key may be provided based on agreed terms that allows recognizing multiple searches as a single billable unit.
\n","type":"text/plain"},"key":"deduplicationKey","value":""}],"variable":[]}},"response":[{"id":"c676d5ac-a264-4c9e-a122-f6bbce9b4e67","name":"Example 1 - Success","originalRequest":{"method":"POST","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{judyrecordsHost}}/api/structured-objects/{{client}}/add-search-by-party-job?search[partyType]=organization&search[orgName]=\"international business machines\" OR \"ibm\"&search[state]=Massachusetts&search[limit]=2000&deduplicationKey=","protocol":"https","host":["{{judyrecordsHost}}"],"path":["api","structured-objects","{{client}}","add-search-by-party-job"],"query":[{"key":"search[partyType]","value":"organization"},{"key":"search[orgName]","value":"\"international business machines\" OR \"ibm\""},{"key":"search[state]","value":"Massachusetts"},{"key":"search[dateFiledStartDate]","value":"2020-01-40","disabled":true},{"key":"search[dateFiledEndDate]","value":"2026-12-31","disabled":true},{"key":"search[limit]","value":"2000"},{"key":"deduplicationKey","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 31 Mar 2026 05:56:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"93"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"data\": {\n \"searchJobId\": \"01KN17DRBC0C0Y5ZNEGGGHBAFA\"\n }\n}"},{"id":"f81d8a40-9618-4cc6-885f-c62fe80a1cdd","name":"Example 2 - Failed","originalRequest":{"method":"POST","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{judyrecordsHost}}/api/structured-objects/{{client}}/add-search-by-party-job?search[partyType]=organization&search[orgName]=\"international business machines\" OR \"ibm\"&search[state]=Massachusetts&search[dateFiledStartDate]=2020-01-40&search[limit]=2000&deduplicationKey=","protocol":"https","host":["{{judyrecordsHost}}"],"path":["api","structured-objects","{{client}}","add-search-by-party-job"],"query":[{"key":"search[partyType]","value":"organization"},{"key":"search[orgName]","value":"\"international business machines\" OR \"ibm\""},{"key":"search[state]","value":"Massachusetts"},{"key":"search[dateFiledStartDate]","value":"2020-01-40"},{"key":"search[dateFiledEndDate]","value":"2026-12-31","disabled":true},{"key":"search[limit]","value":"2000"},{"key":"deduplicationKey","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 31 Mar 2026 06:12:13 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"114"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"errors\": {\n \"search.dateFiledStartDate\": [\n \"If provided, Date Filed Start Date must be a valid date.\"\n ]\n }\n}"}],"_postman_id":"33bbdbc4-3ce5-49d2-8f91-4a0e2a907acb"},{"name":"Step 2 - Get Search By Party Job Status","id":"75bdcdeb-da43-48ad-bb87-677179b7a1e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{judyrecordsHost}}/api/structured-objects/{{client}}/get-search-by-party-job-status?searchJobId={{searchJobId}}","description":"Gets the status of the search job specified by searchJobId. processingStatus may be one of either: pending, succeeded, or failed.
Retrieves the results of the search job specified by searchJobId. For details, see example responses.
For testing use only, allows synchronously running a party search and retrieving the results in the same request.
\n","urlObject":{"protocol":"https","path":["api","structured-objects","{{client}}","search-by-party-synchronous","for-test-use-only"],"host":["{{judyrecordsHost}}"],"query":[{"key":"search[partyType]","value":"individual"},{"key":"search[firstName]","value":"andrew"},{"key":"search[middleNameOrInitial]","value":"l"},{"key":"search[lastName]","value":"buxton"},{"key":"search[state]","value":""},{"disabled":true,"key":"search[dateFiledStartDate]","value":"2014-01-01"},{"disabled":true,"key":"search[dateFiledEndDate]","value":"2026-12-31"},{"key":"search[excludePossibleMatchesMatchingMiddleInitialOnly]","value":"yes"},{"key":"search[excludePossibleMatchesMatchingFirstAndLastNameOnly]","value":"yes"},{"key":"search[limit]","value":"2000"},{"key":"deduplicationKey","value":"999"}],"variable":[]}},"response":[],"_postman_id":"9c41e6fb-be88-4be0-9d78-e4d98d80d08f"},{"name":"Search By Party - Direct - Organization","id":"a468bf20-57ae-4f82-8921-58fa1e21d4ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{judyrecordsHost}}/api/structured-objects/{{client}}/search-by-party-synchronous/for-test-use-only?search[partyType]=organization&search[orgName]=\"international business machines\" OR \"ibm\"&search[state]=Massachusetts&search[limit]=2000&deduplicationKey=","description":"For testing use only, allows synchronously running a party search and retrieving the results in the same request.
\n","urlObject":{"protocol":"https","path":["api","structured-objects","{{client}}","search-by-party-synchronous","for-test-use-only"],"host":["{{judyrecordsHost}}"],"query":[{"key":"search[partyType]","value":"organization"},{"key":"search[orgName]","value":"\"international business machines\" OR \"ibm\""},{"key":"search[state]","value":"Massachusetts"},{"disabled":true,"key":"search[dateFiledStartDate]","value":"2020-01-01"},{"disabled":true,"key":"search[dateFiledEndDate]","value":"2026-12-31"},{"key":"search[limit]","value":"2000"},{"key":"deduplicationKey","value":""}],"variable":[]}},"response":[],"_postman_id":"a468bf20-57ae-4f82-8921-58fa1e21d4ed"},{"name":"Finding cases filed within a date range","id":"a77d97e8-b383-4c7b-bd68-1380250834cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"from\": 0,\r\n \"size\": 5,\r\n \"query\": {\r\n \"range\": {\r\n \"dateFiled\": {\r\n \"gte\": \"2022-01-01\",\r\n \"lte\": \"2022-01-10\",\r\n \"format\": \"yyyy-MM-dd\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{judyrecordsHost}}/api/structured-objects/_all/_search","description":"This request gets cases filed between January 1st 2022 and January 10th, 2022 (inclusive). An offset (from field) and limit (to field) are also specified.
This request gets the count of cases filed between January 1st 2022 and January 10th, 2022 (inclusive). This query is similar to the corresponding query to return cases, but uses the _count API instead of the _search API and does not specify to and from fields since the count query is not used to return results.
This request gets the count of cases filed between January 1st 2022 and January 10th, 2022 (inclusive). This query is similar to the corresponding query to return cases, but uses the _search API's ability to only return the number of result hits. This is done by specifying \"track_total_hits\": true and size: 0. A size of 0 tells the _search API not to return any document results and only the number of result hits.
This section contains recipes for various use cases and aims to be a practical resource for understanding and using the API.
\nThe Structured Objects API is primarily documented in this section, where the idea is to focus on workflows and use cases in contrast to an endpoint-by-endpoint focused approach. However, an endpoint reference section is also available, under the SO API - Endpoints Reference folder.
The Structured Objects API allows searching and retrieving data using finer-grained data fields (e.g., case name, case number, party name, etc.).
\nFor searching, the API primarily leverages the search API of Elasticsearch, which provides a fast, flexible, and powerful system for querying, aggregating, and scoring data. Elasticsearch is also a mature and well-known system where a great deal of existing developer knowledge, documentation, and API tools can be leveraged.
\nFor retrieving individual case records, specific case retrieval endpoints are available.
\n","_postman_id":"d8fb00a1-eeeb-412e-bc1b-b0839db63a03"},{"name":"Full-Text API","item":[{"name":"Search Endpoint","item":[{"name":"Search Endpoint - Overview","id":"2614c2f1-198f-47a5-8962-16daffe599ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.
\n","type":"text"}],"url":"https://{{judyrecordsHost}}/search?search=donald trump","description":"The search endpoint is used to send search queries to judyrecords.
\nThis endpoint combines the functionality of several requests normally needed to complete searches on the website. Instead of calling an endpoint to add a search job, check search job status, and get search job results, each of these functions are combined into a single endpoint for ease of use.
\nWith a single request, a search can be initiated and results retrieved.
\nSee the annotated response below for details about the search endpoint response structure and values.
\n","urlObject":{"protocol":"https","path":["search"],"host":["{{judyrecordsHost}}"],"query":[{"description":{"content":"(required, string) The search query to find matching cases for.
\n","type":"text/plain"},"key":"search","value":"donald trump"},{"disabled":true,"description":{"content":"(optional, int) The maximum number of seconds to wait for a search to complete. If after the specified seconds, the search has not completed, the response is immediately returned with a failed status. Default is 5 seconds.
\nNote: If a search fails due to this time limit being exceeded, the search will currently continue processing in the background and will likely return results immediately upon a subsequent request for the same query.
\n","type":"text/plain"},"key":"maxWaitSec","value":"example: 5"},{"disabled":true,"description":{"content":"(optional, int) The page number of results to return. For pages after the first, page must be specified to navigate search result pages.
\nBy default, the first 2,000 results are displayed for a given search. With 10 results per page, this gives a maximum number of 200 result pages per search. For extended searches (see info page on website), the first 500k results/50k pages are returned.
\n","type":"text/plain"},"key":"page","value":"example: 2"}],"variable":[]}},"response":[{"id":"58b4c473-c468-4855-a4f7-fff0f49a046c","name":"Response Example - Annotated","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.","type":"text"}],"url":{"raw":"https://{{judyrecordsHost}}/search?search=donald trump texas","protocol":"https","host":["{{judyrecordsHost}}"],"path":["search"],"query":[{"key":"search","value":"donald trump texas","description":"(required, string) The search query to find matching cases for."},{"key":"maxWaitSec","value":"example: 5","description":"(optional, int) The maximum number of seconds to wait for a search to complete. If after the specified seconds, the search has not completed, the response is immediately returned with a failed status. Default is 5 seconds.\n\nNote: If a search fails due to this time limit being exceeded, the search will currently continue processing in the background and will likely return results immediately upon a subsequent request for the same query.","type":"text","disabled":true},{"key":"page","value":"example: 2","description":"(optional, int) The page number of results to return. For pages after the first, page must be specified to navigate search result pages.\nBy default, the first 2,000 results are displayed for a given search. With 10 results per page, this gives a maximum number of 200 result pages per search. For extended searches (see info page on website), the first 500k results/50k pages are returned.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 07:42:13 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"1269"},{"key":"Keep-Alive","value":"timeout=5, max=249"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n /* The status of the search. Possible values are failed or succeeded. */\n \"status\": \"succeeded\",\n \n /* The result info pertaining to the search. */\n \"resultInfo\": {\n\n /* The time in milliseconds it took for Elasticsearch to process the search. */\n \"took\": 49,\n \n \"hits\": {\n \n /* Search result hit summary info. */\n \"total\": {\n \n /* The total number of results available for the search. */\n \"value\": 611,\n \n /*\n If track_total_hits is not limited when sending a search to Elasticsearch, this value will always be \"eq\",\n reflecting that the number of results in \"total.value\" matches the total number of matches available. \n If track_total_hits was set/limited to 2,000, the \"total.value\" will never be higher than 2,000 because \n Elasticsearch stops keeping track of hits beyond that limit. However, if Elasticsearch stops keeping track \n of hits because of this setting, the relation will be \"gte\" because \"total.value\" is either greater than or equal \n to where results stopped being counted at.\n \n Currently, track_total_hits is not limited and therefore the true total count is always available. \n In the future, this may change as it remains a potential performance improvement/optimization.\n */\n \"relation\": \"eq\",\n \n /* The total number of results retrieved for this search, which is limited to 2,000 for most searches. */\n \"retrieved\": 611\n },\n \n /* The max score of the search hits returned. */\n \"max_score\": \"1392.384\",\n \n \"hits\": [\n {\n /* The score of this search result hit. */\n \"_score\": \"1392.384\",\n \n /* The most relevant highlight snippet of the document matching the search. */\n \"highlight\": \"Your application API key.
\n"}],"url":"https://{{judyrecordsHost}}/search?search=kristen poe texas","urlObject":{"protocol":"https","path":["search"],"host":["{{judyrecordsHost}}"],"query":[{"description":{"content":"A basic search query containing a name and a state.
\n","type":"text/plain"},"key":"search","value":"kristen poe texas"}],"variable":[]}},"response":[{"id":"63fd4613-0bc7-4cc4-a98f-bd42e5871ed0","name":"Response Example","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.","type":"text"}],"url":{"raw":"https://{{judyrecordsHost}}/search?search=kristen poe texas","protocol":"https","host":["{{judyrecordsHost}}"],"path":["search"],"query":[{"key":"search","value":"kristen poe texas","description":"A basic search query containing a name and a state."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 07:36:59 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"1164"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"resultInfo\": {\n \"took\": 20,\n \"hits\": {\n \"total\": {\n \"value\": 52,\n \"relation\": \"eq\",\n \"retrieved\": 52\n },\n \"max_score\": \"1423.972\",\n \"hits\": [\n {\n \"_score\": \"1423.972\",\n \"highlight\": \"Your application API key.
\n"}],"url":"https://{{judyrecordsHost}}/search?search=kristen poe texas&page=2","urlObject":{"protocol":"https","path":["search"],"host":["{{judyrecordsHost}}"],"query":[{"description":{"content":"A basic search query containing a name and a state.
\n","type":"text/plain"},"key":"search","value":"kristen poe texas"},{"description":{"content":"Specifying the 2nd page of search results.
\n","type":"text/plain"},"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"ad459fef-4506-42b0-b141-842c8ca23e1d","name":"Response Example","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.","type":"text"}],"url":{"raw":"https://{{judyrecordsHost}}/search?search=kristen poe texas&page=2","protocol":"https","host":["{{judyrecordsHost}}"],"path":["search"],"query":[{"key":"search","value":"kristen poe texas","description":"A basic search query containing a name and a state."},{"key":"page","value":"2","description":"Specifying the 2nd page of search results."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 07:38:10 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"1354"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"resultInfo\": {\n \"took\": 20,\n \"hits\": {\n \"total\": {\n \"value\": 52,\n \"relation\": \"eq\",\n \"retrieved\": 52\n },\n \"max_score\": \"1423.972\",\n \"hits\": [\n {\n \"_score\": \"1009.627\",\n \"highlight\": \"Your application API key.
\n"}],"url":"https://{{judyrecordsHost}}/search?search=court williamson&maxWaitSec=6","urlObject":{"protocol":"https","path":["search"],"host":["{{judyrecordsHost}}"],"query":[{"description":{"content":"A basic search query that takes longer than normal to execute (if not cached) due to extremely common terms.
\n","type":"text/plain"},"key":"search","value":"court williamson"},{"description":{"content":"Specifies that the search request should wait up to 6 seconds for results.
\n","type":"text/plain"},"key":"maxWaitSec","value":"6"}],"variable":[]}},"response":[{"id":"5be05f59-0fc0-495c-8296-c0b28ec7e3be","name":"Response Example","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.","type":"text"}],"url":{"raw":"https://{{judyrecordsHost}}/search?search=court williamson&maxWaitSec=9","protocol":"https","host":["{{judyrecordsHost}}"],"path":["search"],"query":[{"key":"search","value":"court williamson","description":"A basic search query that takes longer than normal to execute (if not cached) due to extremely common terms."},{"key":"maxWaitSec","value":"9","description":"Specifies that the search request should wait up to 6 seconds for results."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 07:38:50 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"840"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"resultInfo\": {\n \"took\": 3183,\n \"hits\": {\n \"total\": {\n \"value\": 2888800,\n \"relation\": \"eq\",\n \"retrieved\": 2000\n },\n \"max_score\": \"1012.266\",\n \"hits\": [\n {\n \"_score\": \"1012.266\",\n \"highlight\": \"Your application API key.
\n"}],"url":"https://{{judyrecordsHost}}/search?search=\"kristen poe\"~3 texas","urlObject":{"protocol":"https","path":["search"],"host":["{{judyrecordsHost}}"],"query":[{"description":{"content":"A search query using proximity matching.
\nMore information about proximity searches can be found at the links below.
\nElasticsearch's website:
\n\nLucene's website:
\nhttps://lucene.apache.org/core/2_9_4/queryparsersyntax.html#Proximity%20Searches
\n","type":"text/plain"},"key":"search","value":"\"kristen poe\"~3 texas"}],"variable":[]}},"response":[{"id":"73cc49d2-5091-4f00-ae64-297a54df9d3f","name":"Response Example","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.","type":"text"}],"url":{"raw":"https://{{judyrecordsHost}}/search?search=\"kristen poe\"~3 texas","protocol":"https","host":["{{judyrecordsHost}}"],"path":["search"],"query":[{"key":"search","value":"\"kristen poe\"~3 texas","description":"A search query using proximity matching.\n\nMore information about proximity searches can be found at the links below.\n\nElasticsearch's website:\n\nhttps://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_proximity_searches\n\nLucene's website:\n\nhttps://lucene.apache.org/core/2_9_4/queryparsersyntax.html#Proximity%20Searches"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 07:39:32 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"1219"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"resultInfo\": {\n \"took\": 12,\n \"hits\": {\n \"total\": {\n \"value\": 13,\n \"relation\": \"eq\",\n \"retrieved\": 13\n },\n \"max_score\": \"27.859\",\n \"hits\": [\n {\n \"_score\": \"27.859\",\n \"highlight\": \"Your application API key.
\n"}],"url":"https://{{judyrecordsHost}}/search?search=\"kristen poe\"","urlObject":{"protocol":"https","path":["search"],"host":["{{judyrecordsHost}}"],"query":[{"description":{"content":"A search query specifying an exact match.
\n","type":"text/plain"},"key":"search","value":"\"kristen poe\""}],"variable":[]}},"response":[{"id":"5b4912f0-6a3c-4334-8b0c-514da6ec2a20","name":"Response Example","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.","type":"text"}],"url":{"raw":"https://{{judyrecordsHost}}/search?search=\"kristen poe\"","protocol":"https","host":["{{judyrecordsHost}}"],"path":["search"],"query":[{"key":"search","value":"\"kristen poe\"","description":"A search query specifying an exact match."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 07:40:10 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"1110"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"resultInfo\": {\n \"took\": 11,\n \"hits\": {\n \"total\": {\n \"value\": 11,\n \"relation\": \"eq\",\n \"retrieved\": 11\n },\n \"max_score\": \"23.987\",\n \"hits\": [\n {\n \"_score\": \"23.987\",\n \"highlight\": \"Your application API key.
\n"}],"url":"https://{{judyrecordsHost}}/search?search=texas case","urlObject":{"protocol":"https","path":["search"],"host":["{{judyrecordsHost}}"],"query":[{"description":{"content":"These two search terms (texas and case) are both considered stop words.
\nCommon court words and state names are considered stop words.
\n","type":"text/plain"},"key":"search","value":"texas case"}],"variable":[]}},"response":[{"id":"e9d2dd09-7969-49c7-b406-3cebe66b598d","name":"Response Example","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.","type":"text"}],"url":{"raw":"https://{{judyrecordsHost}}/search?search=texas case","protocol":"https","host":["{{judyrecordsHost}}"],"path":["search"],"query":[{"key":"search","value":"texas case","description":"These two search terms (texas and case) are both considered stop words.\n\nCommon court words and state names are considered stop words."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 07:40:33 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"114"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"errors\": [\n \"At least one non-general search term must be provided.\"\n ]\n}"}],"_postman_id":"c559f130-d268-4d7e-abe8-cba3b71eecbb"},{"name":"Example 5 - Search failure - syntax error","id":"14f0ee1e-e2c3-4f9f-8103-8dc070fa1d5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text","description":"Your application API key.
\n"}],"url":"https://{{judyrecordsHost}}/search?search=\"kristen poe","urlObject":{"protocol":"https","path":["search"],"host":["{{judyrecordsHost}}"],"query":[{"description":{"content":"A search query containing an unmatched double-quote character, leading to a syntax error.
\nThe processingStatusMsg details may be used. However, code using this field should account for the possibility that the content/format of this field may change or be inconsistent.
\n","type":"text/plain"},"key":"search","value":"\"kristen poe"}],"variable":[]}},"response":[{"id":"7610a4b2-7ee5-4585-b806-727c8ea47b20","name":"Response Example","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.","type":"text"}],"url":{"raw":"https://{{judyrecordsHost}}/search?search=\"kristen poe","protocol":"https","host":["{{judyrecordsHost}}"],"path":["search"],"query":[{"key":"search","value":"\"kristen poe","description":"A search query containing an unmatched double-quote character, leading to a syntax error.\n\nThe processingStatusMsg details may be used. However, code using this field should account for the possibility that the content/format of this field may change or be inconsistent."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 07:40:52 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"404"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"processingStatusMsg\": \"{\\\"error\\\":{\\\"root_cause\\\":[{\\\"type\\\":\\\"query_shard_exception\\\",\\\"reason\\\":\\\"Failed to parse query [\\\\\\\"kristen poe]\\\",\\\"index_uuid\\\":\\\"6mrZdfTpQ5q5-k651aekrA\\\",\\\"index\\\":\\\"cases_new\\\"}],\\\"type\\\":\\\"search_phase_execution_exception\\\",\\\"reason\\\":\\\"all shards failed\\\",\\\"phase\\\":\\\"query\\\",\\\"grouped\\\":true,\\\"failed_shards\\\":[{\\\"shard\\\":0,\\\"index\\\":\\\"cases_new\\\",\\\"node\\\":\\\"xpSlX_sBTaqaV8y91HWl9A\\\",\\\"reason\\\":{\\\"type\\\":\\\"query_shard_exception\\\",\\\"reason\\\":\\\"Failed to parse query [\\\\\\\"kristen poe]\\\",\\\"index_uuid\\\":\\\"6mrZdfTpQ5q5-k651aekrA\\\",\\\"index\\\":\\\"cases_new\\\",\\\"caused_by\\\":{\\\"type\\\":\\\"parse_exception\\\",\\\"reason\\\":\\\"Cannot parse '\\\\\\\"kristen poe': Lexical error at line 1, column 13. Encountered:Your application API key.
\n","type":"text"}],"url":"https://{{judyrecordsHost}}/record/upceuyjlb43f","urlObject":{"protocol":"https","path":["record","upceuyjlb43f"],"host":["{{judyrecordsHost}}"],"query":[],"variable":[]}},"response":[{"id":"343a8cb6-0ac1-4d37-bfa1-6a90f0c18dfe","name":"Response Example - Annotated","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","description":"Your application API key.","type":"text"}],"url":"https://{{judyrecordsHost}}/record/upceuyjlb43f"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 08:47:00 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"1262"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n /* The status of the case request. Possible values are failed or succeeded. */\n \"status\": \"succeeded\",\n\n /*\n Title info for the case.\n The \"recordContext\" key usually matches the value in the search result title.\n The \"recordStyle\" is not available in most data sources but allows more detailed title info about a case.\n You can think of these keys as a heading and sub-heading.\n */\n \"caseTitleInfo\": {\n \"recordContext\": \"Wise County, Texas Court Record\",\n \"recordStyle\": null\n },\n\n /* The case data available for this case. */\n \"case\": {\n\n /* The data source case ID for this case. This value is not unique across judyrecords and is only unique within a data source. */\n \"caseId\": \"340843\",\n\n /*\n One or more keys may be present that include the sub-string \"httpreq\".\n This case has only one such key, but some data sources have multiple HTTP request keys.\n \n Importantly, a key with the sub-string \"httpreq\" may contain one or more sub keys that include the sub-string \"httpreq\".\n \n There is no strict naming convention for HTTP request columns with the exception that they must contain the sub-string \"httpreq\" (case insensitive).\n\n The following are examples of valid HTTP request keys you may encounter:\n - httpReq\n - caseDetailsHttpReq\n - caseSummaryHttpReq\n - partyInfoHttpReq\n - httpReqs\n - caseDetailsHttpReqs\n\n In the above list, httpReqs and caseDetailsHttpReqs would contain one or more sub keys that include the sub-string \"httpreq\".\n\n See the following cases for additional helpful examples:\n - https://{{judyrecordsHost}}/record/sjxrjn3z1f0d\n - https://{{judyrecordsHost}}/record/d78lsxca99a8a\n */\n \"caseDetailsHttpReq\": \"| STATE OF TEXAS vs. KRISTEN POE |
|
| Lead Attorneys | ||||
|---|---|---|---|---|
| Defendant | POE, KRISTEN BETH | |||
| State | STATE OF TEXAS | |||
| Charges: POE, KRISTEN BETH | Statute | Level | Date | ||
|---|---|---|---|---|---|
| 1. | SPEEDING 73/55 | 545.351 | Misdemeanor Traffic | 03/08/2017 | |
| DISPOSITIONS | |||
|---|---|---|---|
| 03/31/2017 | Plea (Judicial Officer: Johnson, Craig) 1. SPEEDING 73/55 Nolo Contendere | ||
| 04/05/2017 | Disposition (Judicial Officer: Johnson, Craig) 1. SPEEDING 73/55 Paid Fine | ||
| OTHER EVENTS AND HEARINGS | |||
| 03/23/2017 | Case Filed (OCA) | ||
| 03/31/2017 | Called Office | ||
| 03/31/2017 | Judgment | ||
| 04/04/2017 | E-Mail Received | ||
| 04/05/2017 | Paid in Full |
Your application API key.
\n"}],"url":"https://{{judyrecordsHost}}/record/upceuyjlb43f","urlObject":{"protocol":"https","path":["record","upceuyjlb43f"],"host":["{{judyrecordsHost}}"],"query":[],"variable":[]}},"response":[{"id":"d8563ace-4156-4509-9a56-a64922c14075","name":"Response Example","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"}],"url":"https://{{judyrecordsHost}}/record/upceuyjlb43f"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Apr 2023 21:09:35 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"1262"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"caseTitleInfo\": {\n \"recordContext\": \"Wise County, Texas Court Record\",\n \"recordStyle\": null\n },\n \"case\": {\n \"caseId\": \"340843\",\n \"caseDetailsHttpReq\": \"| STATE OF TEXAS vs. KRISTEN POE |
|
| Lead Attorneys | ||||
|---|---|---|---|---|
| Defendant | POE, KRISTEN BETH | |||
| State | STATE OF TEXAS | |||
| Charges: POE, KRISTEN BETH | Statute | Level | Date | ||
|---|---|---|---|---|---|
| 1. | SPEEDING 73/55 | 545.351 | Misdemeanor Traffic | 03/08/2017 | |
| DISPOSITIONS | |||
|---|---|---|---|
| 03/31/2017 | Plea (Judicial Officer: Johnson, Craig) 1. SPEEDING 73/55 Nolo Contendere | ||
| 04/05/2017 | Disposition (Judicial Officer: Johnson, Craig) 1. SPEEDING 73/55 Paid Fine | ||
| OTHER EVENTS AND HEARINGS | |||
| 03/23/2017 | Case Filed (OCA) | ||
| 03/31/2017 | Called Office | ||
| 03/31/2017 | Judgment | ||
| 04/04/2017 | E-Mail Received | ||
| 04/05/2017 | Paid in Full |
Your application API key.
\n"}],"url":"https://{{judyrecordsHost}}/record/upceuyjlb43ff","urlObject":{"protocol":"https","path":["record","upceuyjlb43ff"],"host":["{{judyrecordsHost}}"],"query":[],"variable":[]}},"response":[{"id":"6dfbde91-6cc2-4d5f-b741-2594de124d54","name":"Response Example","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"}],"url":"https://{{judyrecordsHost}}/record/upceuyjlb43ff"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Apr 2023 21:10:07 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Length","value":"84"},{"key":"Keep-Alive","value":"timeout=5, max=250"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"processingStatusMsg\": \"Record not found.\"\n}"}],"_postman_id":"fa942b85-b2af-45ce-93d3-8eb9497c8ea9"}],"id":"ce1b96f2-e707-45b6-9e03-d7301487e2dd","_postman_id":"ce1b96f2-e707-45b6-9e03-d7301487e2dd","description":""}],"id":"cb13f62d-d1be-466d-9665-6c10d8c13709","_postman_id":"cb13f62d-d1be-466d-9665-6c10d8c13709","description":""}]}