top

Regions

View all available regions.

Retrieve all regions

Retrieve a list of regions with no pagination. Regions collection is referential to other collections.

Get/regions

Path Parameters

No query or path parameters are needed to get a list of regions.
List Regions
curl -v -X GET https://api.swfi.com/v1/regions \ 
-H "Accept: application/json" \ 
-H "Authorization: $API_KEY"

Success Response

HTTP Status 200
data
TYPEobject[]
Array of strings.

total_items
TYPEinteger
The total length of the data object.
Example response
{
  "data": [
    "Africa",
    "Antarctica Region",
    "Asia",
    "Australia and Pacific",
    "Europe",
    "Global",
    "Latin America",
    "Middle East",
    "North America"
  ],
  "total_items": 9
}

Error Response

message
TYPEstring
A short, human-readable summary of the problem type.

status
TYPEinteger
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurance of the problem.
Example response
{
  "errors": [
      {
          "path": "/v1/aum/:_id",
          "message": "Not Found"
      }
  ],
  "status": 404
}
Documentation as of 10/19/2022