GET /v1/accounts/{accountId}

Retrieves the account with the given id

Path parameters

  • accountId string Required

    Account id

Responses

  • 200 */*

    Success

    Hide response attributes Show response attributes object
    • id string Required
    • name string Required
    • trackedSubscriptionId string
    • sfdcId string
    • lastSeenDate integer(int64)
    • dunsNumber string
    • industry string
    • numberOfEmployees integer(int32)
    • sicCode string
    • website string
    • naicsCode string
    • plan string
    • location object

      Location object

      Hide location attributes Show location attributes object
      • countryName string
      • countryCode string

        See ISO 3166

      • stateName string
      • stateCode string

        See ISO 3166

      • city string
      • street string
      • postalCode string
      • continent string

        See ISO 3166

      • regionName string

        See ISO 3166-2

      • timeZone string
      • coordinates object

        Coordinates object

        Hide coordinates attributes Show coordinates attributes object
        • latitude number(double)
        • longitude number(double)
    • numberOfUsers integer(int32)

      Number of users

    • propertyKeys array[string] Required

      Aptrinsic Tag Key, at least one is required

    • createDate integer(int64)
    • lastModifiedDate integer(int64)
    • customAttributes object

      Map of apiName to value

    • parentGroupId string

      Id to group Accounts together

    • renewalDate integer(int64)
    • healthScore integer(int32)
    • gsId string
    • nps number(float)
    • csm string
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 404

    Account not found

  • 429

    Rate limit exceeded

GET /v1/accounts/{accountId}
curl \
 --request GET 'https://api.aptrinsic.com/v1/accounts/{accountId}'
Response examples (200)
{
  "id": "string",
  "name": "string",
  "trackedSubscriptionId": "string",
  "sfdcId": "string",
  "lastSeenDate": 42,
  "dunsNumber": "string",
  "industry": "string",
  "numberOfEmployees": 42,
  "sicCode": "string",
  "website": "string",
  "naicsCode": "string",
  "plan": "string",
  "location": {
    "countryName": "United States",
    "countryCode": "USA",
    "stateName": "California",
    "stateCode": "CA",
    "city": "San Mateo",
    "street": "101 Broadway",
    "postalCode": 94010,
    "continent": "NA",
    "regionName": "string",
    "timeZone": "string",
    "coordinates": {
      "latitude": 37.567147,
      "longitude": -122.324211
    }
  },
  "numberOfUsers": 42,
  "propertyKeys": [
    "AP-XXXXXXXXXX-2"
  ],
  "createDate": 42,
  "lastModifiedDate": 42,
  "customAttributes": {},
  "parentGroupId": "string",
  "renewalDate": 42,
  "healthScore": 42,
  "gsId": "string",
  "nps": 42.0,
  "csm": "string"
}