Skip to content

Get the coverage profile

Request

Retrieves the coverage profile

Security
ApiKeyAuth
Path
coverageIdstringrequired
GET
/v3/coverage-profiles/{coverageId}
curl -i -X GET \
  'https://api.tellisim.com/v3/coverage-profiles/{coverageId}?key=YOUR_API_KEY_HERE'

Responses

Successful response containing coverage profile details

Bodyapplication/json
errorbooleanrequired

Indicates whether an error occurred during the request

Example:false
dataobject(CoverageProfile)required
Response
{
  "error": false,
  "data": {
    "coverage_id": "24648a7f-8281-4af7-8fc0-19b2371b2d1d",
    "label": "Green",
    "region_name": "United States",
    "region_code": "US",
    "countries": [ … ]
  }
}