GET
/
v1
/
accounts
/
{accountId}
Fetch account
curl --request GET \
  --url https://api.sakari.io/v1/accounts/{accountId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "<string>",
    "apiCredentials": {
      "id": "<string>",
      "secret": "<string>"
    },
    "name": "<string>",
    "plan": {
      "id": "<string>",
      "name": "<string>",
      "price": 123,
      "commitment": 123,
      "credit": 123,
      "maxCommitment": 123,
      "minCommitment": 123,
      "passThroughPlanEligible": true,
      "billingFrequency": "monthly",
      "pricing": {},
      "includedPhoneNumberCountries": [
        "<string>"
      ]
    },
    "balance": 123,
    "defaults": {
      "country": {
        "code": "<string>",
        "name": "<string>"
      }
    },
    "promoCode": "<string>",
    "subscription": {
      "activeUntil": "<string>"
    },
    "nextBillingDate": "<string>",
    "trialExpiry": "2023-11-07T05:31:56Z",
    "questionare": {},
    "referrer": "<string>",
    "externalName": "<string>",
    "legalName": "<string>",
    "info": {
      "website": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": {
          "code": "<string>",
          "flag": "<string>",
          "dialing": "<string>",
          "name": "<string>",
          "aliass": [
            "<string>"
          ],
          "continent": "<string>",
          "supported": true,
          "alphaNumericSenderId": true,
          "taxTypes": [
            {
              "type": "<string>",
              "name": "<string>",
              "example": "<string>"
            }
          ]
        },
        "postalCode": "<string>"
      }
    },
    "options": {
      "universalMMS": true,
      "verifyNumberType": true,
      "autoLinkShorten": true,
      "autotopup": {
        "amount": 123,
        "below": 123
      },
      "autoEnroll": {
        "domain": "<string>",
        "role": "<string>",
        "notifyEmail": "<string>"
      },
      "customDomain": {
        "id": "<string>",
        "domain": "<string>",
        "renewAt": "<string>",
        "verified": "<string>",
        "created": {
          "at": "2023-11-07T05:31:56Z",
          "by": {
            "id": "<string>",
            "name": "Joe Bloggs",
            "firstName": "Joe",
            "lastName": "Bloggs",
            "email": "joe@bloggs.com",
            "source": "<string>",
            "subSource": "<string>"
          }
        }
      }
    },
    "integrations": {},
    "partner": {
      "paypalEmail": "<string>",
      "submitted": "2023-11-07T05:31:56Z",
      "approved": "2023-11-07T05:31:56Z",
      "rejected": "2023-11-07T05:31:56Z",
      "contact": "<string>"
    },
    "referralCode": "<string>",
    "questionnaire": {},
    "billing": {
      "name": "<string>",
      "email": "<string>",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": {
          "code": "<string>",
          "flag": "<string>",
          "dialing": "<string>",
          "name": "<string>",
          "aliass": [
            "<string>"
          ],
          "continent": "<string>",
          "supported": true,
          "alphaNumericSenderId": true,
          "taxTypes": [
            {
              "type": "<string>",
              "name": "<string>",
              "example": "<string>"
            }
          ]
        },
        "postalCode": "<string>"
      },
      "tax": {
        "type": "<string>",
        "id": "<string>"
      }
    },
    "created": {
      "at": "2023-11-07T05:31:56Z"
    },
    "suspended": {
      "at": "2023-11-07T05:31:56Z"
    },
    "user": {
      "role": "<string>",
      "segmentUnderstanding": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

accountId
string
required

Account to apply operations to

Response

200
application/json

successful operation

The response is of type object.