Retrieve account data

Returns comprehensive engagement metrics and insights for a customer account.

Required Parameters:

  • workspace_id: Your scoring workspace ID (provided during onboarding)
  • One of the following lookup methods:
    • id: The internal Accoil account ID
    • match_type + match_value: Match by account traits

Example URL: https://app.accoil.com/48/scores/123/accounts/154

  • workspace_id = 123 (the numeric ID after /scores/ and /accounts/)
  • id = 154 (the final id of the URL, is the Internal ID)

Lookup Methods:

  1. By Internal ID (fastest):

    • Use id parameter with the Accoil internal account ID
    • Example: id=6
  2. By Account Traits (flexible):

    • Use match_type and match_value parameters
    • Common match types for accounts:
      • domain: Match by company domain (e.g., "example.com")
      • name: Match by account name
      • tracking_id: Match by your external tracking ID
      • intercom_id: Match by Intercom company ID
      • salesforce_id: Match by Salesforce account ID
      • Any custom trait you've configured
    • Example: match_type=domain&match_value=example.com

Expansions: Use the expand parameter to include additional data:

  • insights: AI-generated account health analysis and recommendations
  • traits: Account attributes and custom properties
  • segments: Account segmentation and grouping data
Language
Credentials
Bearer
Click Try It! to start a request and see the response here!