Countries API

get listing

GET /api/rest/customer/v1/countries

Parameters

Name Description
filter[id] id filter
filter[name] name filter
filter[iso2] iso2 filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjoyNCwiZXhwIjoxNzY3MzU4MDM0fQ.haQqaN7dn1db1Fgq63tKyA6uBFbZHSlKWSUi5QQnPG8
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/countries

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
vary: Accept
etag: W/"17483314563eb25c446d066b061a54a9"
cache-control: max-age=0, private, must-revalidate
x-request-id: c7731cfc-02d4-4e52-8b63-45db929a23c9
x-runtime: 0.012723
content-length: 7844

Status

200 OK

Body

{
  "data": [
    {
      "id": "1",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/1"
      },
      "attributes": {
        "name": "Afghanistan",
        "iso2": "AF"
      }
    },
    {
      "id": "2",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/2"
      },
      "attributes": {
        "name": "Albania",
        "iso2": "AL"
      }
    },
    {
      "id": "3",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/3"
      },
      "attributes": {
        "name": "Algeria",
        "iso2": "DZ"
      }
    },
    {
      "id": "4",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/4"
      },
      "attributes": {
        "name": "American Samoa",
        "iso2": "AS"
      }
    },
    {
      "id": "5",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/5"
      },
      "attributes": {
        "name": "Andorra",
        "iso2": "AD"
      }
    },
    {
      "id": "6",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/6"
      },
      "attributes": {
        "name": "Angola",
        "iso2": "AO"
      }
    },
    {
      "id": "7",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/7"
      },
      "attributes": {
        "name": "Anguilla",
        "iso2": "AI"
      }
    },
    {
      "id": "8",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/8"
      },
      "attributes": {
        "name": "Antarctica",
        "iso2": "AQ"
      }
    },
    {
      "id": "9",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/9"
      },
      "attributes": {
        "name": "Antigua And Barbuda",
        "iso2": "AG"
      }
    },
    {
      "id": "10",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/10"
      },
      "attributes": {
        "name": "Argentina",
        "iso2": "AR"
      }
    },
    {
      "id": "11",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/11"
      },
      "attributes": {
        "name": "Armenia",
        "iso2": "AM"
      }
    },
    {
      "id": "12",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/12"
      },
      "attributes": {
        "name": "Aruba",
        "iso2": "AW"
      }
    },
    {
      "id": "13",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/13"
      },
      "attributes": {
        "name": "Australia",
        "iso2": "AU"
      }
    },
    {
      "id": "14",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/14"
      },
      "attributes": {
        "name": "Austria",
        "iso2": "AT"
      }
    },
    {
      "id": "15",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/15"
      },
      "attributes": {
        "name": "Azerbaijan",
        "iso2": "AZ"
      }
    },
    {
      "id": "16",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/16"
      },
      "attributes": {
        "name": "Bahamas",
        "iso2": "BS"
      }
    },
    {
      "id": "17",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/17"
      },
      "attributes": {
        "name": "Bahrain",
        "iso2": "BH"
      }
    },
    {
      "id": "18",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/18"
      },
      "attributes": {
        "name": "Bangladesh",
        "iso2": "BD"
      }
    },
    {
      "id": "19",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/19"
      },
      "attributes": {
        "name": "Barbados",
        "iso2": "BB"
      }
    },
    {
      "id": "20",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/20"
      },
      "attributes": {
        "name": "Belarus",
        "iso2": "BY"
      }
    },
    {
      "id": "21",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/21"
      },
      "attributes": {
        "name": "Belgium",
        "iso2": "BE"
      }
    },
    {
      "id": "22",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/22"
      },
      "attributes": {
        "name": "Belize",
        "iso2": "BZ"
      }
    },
    {
      "id": "23",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/23"
      },
      "attributes": {
        "name": "Benin",
        "iso2": "BJ"
      }
    },
    {
      "id": "24",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/24"
      },
      "attributes": {
        "name": "Bermuda",
        "iso2": "BM"
      }
    },
    {
      "id": "25",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/25"
      },
      "attributes": {
        "name": "Bhutan",
        "iso2": "BT"
      }
    },
    {
      "id": "26",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/26"
      },
      "attributes": {
        "name": "Bolivia",
        "iso2": "BO"
      }
    },
    {
      "id": "274",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/274"
      },
      "attributes": {
        "name": "Bonaire Sint Eustatius and Saba",
        "iso2": "BQ"
      }
    },
    {
      "id": "27",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/27"
      },
      "attributes": {
        "name": "Bosnia And Herzegovina",
        "iso2": "BA"
      }
    },
    {
      "id": "28",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/28"
      },
      "attributes": {
        "name": "Botswana",
        "iso2": "BW"
      }
    },
    {
      "id": "29",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/29"
      },
      "attributes": {
        "name": "Bouvet Island",
        "iso2": "BV"
      }
    },
    {
      "id": "30",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/30"
      },
      "attributes": {
        "name": "Brazil",
        "iso2": "BR"
      }
    },
    {
      "id": "282",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/282"
      },
      "attributes": {
        "name": "British Indian Ocean Territory",
        "iso2": "IO"
      }
    },
    {
      "id": "232",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/232"
      },
      "attributes": {
        "name": "British Virgin Islands",
        "iso2": "VG"
      }
    },
    {
      "id": "32",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/32"
      },
      "attributes": {
        "name": "Brunei Darussalam",
        "iso2": "BN"
      }
    },
    {
      "id": "33",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/33"
      },
      "attributes": {
        "name": "Bulgaria",
        "iso2": "BG"
      }
    },
    {
      "id": "34",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/34"
      },
      "attributes": {
        "name": "Burkina Faso",
        "iso2": "BF"
      }
    },
    {
      "id": "35",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/35"
      },
      "attributes": {
        "name": "Burundi",
        "iso2": "BI"
      }
    },
    {
      "id": "36",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/36"
      },
      "attributes": {
        "name": "Cambodia",
        "iso2": "KH"
      }
    },
    {
      "id": "37",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/37"
      },
      "attributes": {
        "name": "Cameroon",
        "iso2": "CM"
      }
    },
    {
      "id": "38",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/38"
      },
      "attributes": {
        "name": "Canada",
        "iso2": "CA"
      }
    },
    {
      "id": "279",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/279"
      },
      "attributes": {
        "name": "Canary Islands",
        "iso2": "IC"
      }
    },
    {
      "id": "39",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/39"
      },
      "attributes": {
        "name": "Cape Verde",
        "iso2": "CV"
      }
    },
    {
      "id": "40",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/40"
      },
      "attributes": {
        "name": "Cayman Islands",
        "iso2": "KY"
      }
    },
    {
      "id": "41",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/41"
      },
      "attributes": {
        "name": "Central African Republic",
        "iso2": "CF"
      }
    },
    {
      "id": "42",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/42"
      },
      "attributes": {
        "name": "Chad",
        "iso2": "TD"
      }
    },
    {
      "id": "43",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/43"
      },
      "attributes": {
        "name": "Chile",
        "iso2": "CL"
      }
    },
    {
      "id": "44",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/44"
      },
      "attributes": {
        "name": "China",
        "iso2": "CN"
      }
    },
    {
      "id": "45",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/45"
      },
      "attributes": {
        "name": "Christmas Island",
        "iso2": "CX"
      }
    },
    {
      "id": "47",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/47"
      },
      "attributes": {
        "name": "Colombia",
        "iso2": "CO"
      }
    },
    {
      "id": "48",
      "type": "countries",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/countries/48"
      },
      "attributes": {
        "name": "Comoros",
        "iso2": "KM"
      }
    }
  ],
  "meta": {
    "total-count": 250
  },
  "links": {
    "first": "http://example.org/api/rest/customer/v1/countries?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "next": "http://example.org/api/rest/customer/v1/countries?page%5Bnumber%5D=2&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/customer/v1/countries?page%5Bnumber%5D=5&page%5Bsize%5D=50"
  }
}