List external customer analytics accounts

v1.0.0

List tracked accounts with external IDs, lifecycle timestamps, and active relationship assignments. Set include_ignored=true to include ignored accounts. Requires a project secret API key with the account:read scope.

Input

{
  "type": "object",
  "properties": {
    "assigned_only": {
      "type": "boolean"
    },
    "cursor": {
      "type": "string"
    },
    "include_ignored": {
      "type": "boolean"
    },
    "limit": {
      "type": "integer"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "next_cursor",
    "results"
  ],
  "properties": {
    "next_cursor": {
      "type": [
        "string",
        "null"
      ],
      "description": "Account UUID to pass as `cursor` for the next page, or null when the list is exhausted."
    },
    "results": {
      "type": "array",
      "description": "Accounts in this page, ordered by account id.",
      "items": {
        "type": "object",
        "required": [
          "churned_at",
          "external_id",
          "ignored_at",
          "name",
          "relationships"
        ],
        "properties": {
          "churned_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the account churned, or null if it has not churned."
          },
          "external_id": {
            "type": "string",
            "description": "External account key used by downstream systems."
          },
          "ignored_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When Track Rules ignored the account, or null if it is tracked."
          },
          "name": {
            "type": "string",
            "description": "Human-readable account name."
          },
          "relationships": {
            "type": "object",
            "description": "Active relationship assignments to current organization members, keyed by relationship definition name (e.g. 'CSM', 'Account executive'). Definitions with no active assignment are omitted."
          }
        }
      }
    }
  }
}