Surge
GET
/accounts/{account_id}/status

Check an account's status and capabilities

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

account_id*string

ID of the account to check

Query Parameters

capabilities?array<>

capabilities about which to check the status

Response Body

application/json

application/json

curl -X GET "https://api.surge.app/accounts/acct_01jpqjvfg9enpt7pyxd60pcmxj/status"
{
  "capabilities": {
    "local_messaging": {
      "errors": [
        {
          "field": "organization.registered_name",
          "message": "The provided EIN doesn't match the organization's registered name.",
          "type": "ein_mismatch"
        }
      ],
      "fields_needed": [],
      "status": "error"
    },
    "phone_calls": {
      "errors": [],
      "fields_needed": [],
      "status": "ready"
    },
    "toll_free_messaging": {
      "errors": [],
      "fields_needed": [
        "organization.contact.title_other",
        "organization.mobile_number"
      ],
      "status": "incomplete"
    }
  }
}
{
  "error": {
    "message": "The requested resource could not be found.",
    "type": "not_found"
  }
}