gainsight-px-rest-api
GET /v1/accounts

Retrieves accounts. Supports filtering, sorting and paging.

Filtering

The filter parameter accepts a list of semicolon-separated filters in the form: {fieldName}{operator}{fieldValue} Filter terms within a single filter parameter are joined by a logical AND. Separate filter parameters are joined by a logical OR.

Operators
Operator Meaning
== Exact match
!= Not equal
< Less than
<= Less than or equal
> Greater than
>= Greater than or equal
~ Matches string, supports wildcard characters * and ?
!~ Not like, supports wildcard characters * and ?

Examples:

URI Results
GET /v1/accounts?filter=sicCode==64;numberOfEmployees>25 Accounts with sicCode of 64 and more than 25 employees.
GET /v1/accounts?filter=sicCode==64;numberOfEmployees>25&filter=sicCode==63;numberOfEmployees>3000 Accounts with: (sicCode of 64 AND more than 25 employees) OR (sicCode of 63 AND more than 3000 employees).
GET /v1/accounts?filter=location.cityName==Portland Accounts with a city of 'Portland'.
GET /v1/accounts?filter=customAttributes.internalId==12345 Accounts with a custom attribute of internalId equal to 12345'.

Sorting

The sort parameter accepts a list of semi-colon separated fields names, each with an optional dash to imply descending sort order. Examples:

URI Results
GET /v1/accounts?sort=name;location.stateCode Accounts sorted by name and state code in ascending order.
GET /v1/accounts?sort=-createDate Accounts sorted by createDate in descending order.

Query parameters

  • filter array[string]

    Filters

  • pageSize integer(int32)

    Number of accounts per page

    Minimum value is 1, maximum value is 1000. Default value is 25.

  • scrollId string

    Used for fetching subsequent pages after the first one. Returned in response.scrollId

  • sort string

    Sort

Responses

  • 200 */*

    Success

    Hide response attributes Show response attributes object
    • accounts array[object]

      Array of accounts

      Hide accounts attributes Show accounts attributes object

      Account 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
    • totalHits integer(int64)

      Total number of records matching filters

    • scrollId string

      If passed on subsequent requests as the scrollId parameter, will fetch the next page
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

GET /v1/accounts 
curl \
 --request GET 'https://api.aptrinsic.com/v1/accounts'
Response examples (200) 
{
  "accounts": [
    {
      "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"
    }
  ],
  "totalHits": 42,
  "scrollId": "string"
}