Skip to main content
GET
/
api
/
v1
/
core
/
coverage
Coverage-API
curl --request GET \
  --url https://api-stage.orchestro.ai/e1/api/v1/core/coverage \
  --header 'Authorization: <api-key>'
{ "coverage": [ { "serviceType": "DGRD", "zip": [ "00501", "00544", "00579", "04773", "04774", "04775", "04776", "04777", "04779", "04780", "04781", "04783", "04785" ] } ] }

Authorizations

​
Authorization
string
header
required

Query Parameters

​
accountNumber
string
required

The account number of the user or entity requesting the coverage information. This is a required parameter and must be passed in the query

Example:

"AC0088"

​
serviceType
string
required

The type of service for which coverage is being requested.

Example:

"GRD/DGRD"

Response

200 - application/json

Coverage API request Successful for GRD/DGRD

​
coverage
object[]
Example:
[
  {
    "serviceType": "GRD",
    "zip": [
      "01001",
      "01002",
      "01003",
      "01004",
      "01007",
      "01009",
      "01010",
      "01013",
      "01014",
      "01020",
      "01021",
      "01022",
      "01027"
    ]
  }
]