changedInput schema / properties / limit / description
Previous value: -"Maximum results to return (1–100)"New value: +"Maximum results per page (1–100)"
addedInput schema / properties / page
Added value: +{
+ "default": 1,
+ "description": "Page number (1-based) — request the next page to retrieve matches beyond the first",
+ "maximum": 9007199254740991,
+ "minimum": 1,
+ "type": "integer"
+}
removedOutput schema / properties / cap
Removed value: -{
- "description": "The limit that was applied.",
- "type": "number"
-}
addedOutput schema / properties / has_next
Added value: +{
+ "description": "Whether there are more pages of results",
+ "type": "boolean"
+}
changedOutput schema / properties / notice / description
Previous value: -"Recovery hint when results are empty — suggests how to broaden the search. Absent when results are present."New value: +"Recovery hint — how to continue to the next page when more results exist, or how to broaden the search when empty. Absent when the full match set fits on this page."
addedOutput schema / properties / page
Added value: +{
+ "description": "Current page number returned",
+ "type": "number"
+}
addedOutput schema / properties / page_metadata
Added value: +{
+ "additionalProperties": false,
+ "description": "Pagination metadata — page through with the page input to reach later matches",
+ "properties": {
+ "has_next": {
+ "description": "Whether there are more pages of results",
+ "type": "boolean"
+ },
+ "limit": {
+ "description": "Results per page",
+ "type": "number"
+ },
+ "page": {
+ "description": "Current page number",
+ "type": "number"
+ },
+ "total": {
+ "description": "Total matching recipients across all pages",
+ "type": "number"
+ }
+ },
+ "required": [
+ "page",
+ "has_next",
+ "limit"
+ ],
+ "type": "object"
+}
changedOutput schema / properties / recipient_count / description
Previous value: -"Number of matching recipients returned"New value: +"Number of matching recipients returned on this page"
removedOutput schema / properties / results / items / properties / location
Removed value: -{
- "additionalProperties": false,
- "description": "Recipient address location",
- "properties": {
- "city_name": {
- "description": "City of recipient address",
- "type": "string"
- },
- "country_code": {
- "description": "Country code",
- "type": "string"
- },
- "state_code": {
- "description": "State code",
- "type": "string"
- }
- },
- "type": "object"
-}
removedOutput schema / properties / results / items / properties / state
Removed value: -{
- "description": "State code of recipient address",
- "type": "string"
-}
removedOutput schema / properties / shown
Removed value: -{
- "description": "Number of recipients returned.",
- "type": "number"
-}
removedOutput schema / properties / total
Removed value: -{
- "description": "Number of results returned",
- "type": "number"
-}
addedOutput schema / properties / totalCount
Added value: +{
+ "description": "Total matching recipients across all pages",
+ "type": "number"
+}
removedOutput schema / properties / truncated
Removed value: -{
- "description": "True when results were capped at the limit.",
- "type": "boolean"
-}
changedOutput schema / required
Previous value: -[
- "results",
- "total",
- "recipient_count"
-]New value: +[
+ "results",
+ "page_metadata",
+ "recipient_count",
+ "page",
+ "has_next"
+]