AI Search

Get Zip Code

This metadata API is used to retrieve ZIP or postal code information for supported countries. It helps in configuring zipcode-level geo-targeting in deal setup.

Note: This API is designed to filter zip codes by a numeric string using the search parameter.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/zip-code

Parameters

Headers

Field Name Type Is mandatory (Y/N)? Description
Authorization String Y Bearer token for authentication (Bearer <token>)
X-USER-ID String Y The ID of the user making the request
X-INMOBI-ORG-ID String Y The organization ID associated with the user
Content-Type String Y Specifies the media type of the request body. Use: application/json

Query Parameters

Field Name Type Is mandatory (Y/N)? Description
search String Y Zip code or part of it to filter the results

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/zip-code?search=302012" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": {
    "countries": [
      {
        "id": 11,
        "name": "India",
        "zipcodes": [
          {
            "id": 5558498,
            "code": "302012"
          }
        ]
      }
    ],
    "pageNum": 1,
    "numItems": 1,
    "nextPage": false,
    "totalItems": 1,
    "totalPages": 1
  }
}

On This Page

Last Updated on: 18 Jul, 2025