GET /api/v2/accounts
List accounts

Examples

GET /api/v2/accounts
200
{
  "data": [
    {
      "id": "425",
      "type": "accounts",
      "links": {
        "self": "http://test.host/api/v2/accounts/425"
      },
      "attributes": {
        "custom-footer": null,
        "name": "Claud Pfeffer",
        "company-name": null,
        "avatar-url": {
          "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/425/small/test.png?1513677251",
          "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/425/medium/test.png?1513677251",
          "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/425/large/test.png?1513677251",
          "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/425/xlarge/test.png?1513677251"
        },
        "country": null,
        "joined-in-at": "2017-12-19T17:54:11.761+08:00",
        "title": null,
        "is-insight-provider": false,
        "is-client": true,
        "min-market-cap": null,
        "max-market-cap": null,
        "slug": "claud-pfeffer",
        "is-synthetic": false,
        "ip-rank": null,
        "funnel-status": null,
        "push-notification-setting": {
          "real-time-alert": true
        },
        "insight-provider-type": null,
        "client-type": "professional",
        "is-dormant": false,
        "short-name": "Jerry",
        "gender": "male",
        "has-changed-password": false,
        "mobile": null,
        "landline": null,
        "team-size": null,
        "trial-end-date": null,
        "areas-of-expertise": null,
        "activated": true,
        "is-compliance-officer": false,
        "has-distribution-restriction": false,
        "jurisdictions": [],
        "disclaimer": null,
        "team-leader": false,
        "is-introducer": false,
        "is-introducer-leader": false,
        "offer-premium-services": null,
        "premium-services-rate": null,
        "is-followed": false,
        "introduced-total-follows": 0,
        "compliance": null,
        "compliance-download-link": null,
        "is-muted": false,
        "total-unread-notifications": 0,
        "client-agreed-at": null,
        "intercom-hash": "43f357ba55e96af0d2145f710e5d66999ac1c5a396a7c38067e0ff7b38afe51a"
      },
      "relationships": {
        "company": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/company",
            "related": "http://test.host/api/v2/accounts/425/company"
          }
        },
        "account-lead": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/account-lead",
            "related": "http://test.host/api/v2/accounts/425/account-lead"
          }
        },
        "introducer": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/introducer",
            "related": "http://test.host/api/v2/accounts/425/introducer"
          }
        },
        "introducer-company": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/introducer-company",
            "related": "http://test.host/api/v2/accounts/425/introducer-company"
          }
        },
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/content-verticals",
            "related": "http://test.host/api/v2/accounts/425/content-verticals"
          }
        },
        "insights": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/insights",
            "related": "http://test.host/api/v2/accounts/425/insights"
          }
        },
        "entities": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/entities",
            "related": "http://test.host/api/v2/accounts/425/entities"
          }
        },
        "countries": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/countries",
            "related": "http://test.host/api/v2/accounts/425/countries"
          }
        },
        "sectors": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/sectors",
            "related": "http://test.host/api/v2/accounts/425/sectors"
          }
        },
        "introduced-accounts": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/introduced-accounts",
            "related": "http://test.host/api/v2/accounts/425/introduced-accounts"
          }
        },
        "premium-services": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/premium-services",
            "related": "http://test.host/api/v2/accounts/425/premium-services"
          }
        },
        "introduced-trending-insight-providers": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/introduced-trending-insight-providers",
            "related": "http://test.host/api/v2/accounts/425/introduced-trending-insight-providers"
          }
        },
        "introduced-trending-insights": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/introduced-trending-insights",
            "related": "http://test.host/api/v2/accounts/425/introduced-trending-insights"
          }
        },
        "introduced-trending-entities": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/introduced-trending-entities",
            "related": "http://test.host/api/v2/accounts/425/introduced-trending-entities"
          }
        },
        "filter-presets": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/filter-presets",
            "related": "http://test.host/api/v2/accounts/425/filter-presets"
          }
        },
        "external-reports": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/external-reports",
            "related": "http://test.host/api/v2/accounts/425/external-reports"
          }
        },
        "annotations": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/annotations",
            "related": "http://test.host/api/v2/accounts/425/annotations"
          }
        },
        "locker-items": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/locker-items",
            "related": "http://test.host/api/v2/accounts/425/locker-items"
          }
        },
        "muted-items": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/muted-items",
            "related": "http://test.host/api/v2/accounts/425/muted-items"
          }
        },
        "follows": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/follows",
            "related": "http://test.host/api/v2/accounts/425/follows"
          }
        },
        "following-accounts": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/following-accounts",
            "related": "http://test.host/api/v2/accounts/425/following-accounts"
          }
        },
        "push-notification-tokens": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/push-notification-tokens",
            "related": "http://test.host/api/v2/accounts/425/push-notification-tokens"
          }
        },
        "qva-reports": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/qva-reports",
            "related": "http://test.host/api/v2/accounts/425/qva-reports"
          }
        },
        "comments": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/comments",
            "related": "http://test.host/api/v2/accounts/425/comments"
          }
        },
        "shared-items": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/shared-items",
            "related": "http://test.host/api/v2/accounts/425/shared-items"
          }
        },
        "account-point": {
          "links": {
            "self": "http://test.host/api/v2/accounts/425/relationships/account-point",
            "related": "http://test.host/api/v2/accounts/425/account-point"
          }
        }
      }
    },
    {
      "id": "426",
      "type": "accounts",
      "links": {
        "self": "http://test.host/api/v2/accounts/426"
      },
      "attributes": {
        "custom-footer": null,
        "name": "Maximus Jackson",
        "company-name": null,
        "avatar-url": {
          "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/426/small/test.png?1513677251",
          "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/426/medium/test.png?1513677251",
          "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/426/large/test.png?1513677251",
          "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/426/xlarge/test.png?1513677251"
        },
        "country": null,
        "joined-in-at": "2017-12-19T17:54:12.041+08:00",
        "title": null,
        "is-insight-provider": true,
        "is-client": false,
        "min-market-cap": null,
        "max-market-cap": null,
        "slug": "maximus-jackson",
        "is-synthetic": false,
        "ip-rank": null,
        "funnel-status": null,
        "push-notification-setting": null,
        "insight-provider-type": "external",
        "client-type": null,
        "is-dormant": false,
        "short-name": "Jerry",
        "gender": "plural",
        "has-changed-password": null,
        "mobile": null,
        "landline": null,
        "team-size": null,
        "trial-end-date": null,
        "areas-of-expertise": {
          "industry-group-primary": null,
          "industry-group-secondary": null,
          "industry-primary": null,
          "industry-secondary": null,
          "market-caps": "Any",
          "sector-generalist": true,
          "country-generalist": true,
          "asset-class-primary": "Equities",
          "content-vertical-generalist": true
        },
        "activated": true,
        "is-compliance-officer": false,
        "has-distribution-restriction": false,
        "jurisdictions": [],
        "disclaimer": null,
        "team-leader": false,
        "is-introducer": false,
        "is-introducer-leader": false,
        "offer-premium-services": false,
        "premium-services-rate": null,
        "is-followed": false,
        "introduced-total-follows": 0,
        "compliance": null,
        "compliance-download-link": null,
        "is-muted": false,
        "total-unread-notifications": null,
        "client-agreed-at": null,
        "intercom-hash": null
      },
      "relationships": {
        "company": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/company",
            "related": "http://test.host/api/v2/accounts/426/company"
          }
        },
        "account-lead": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/account-lead",
            "related": "http://test.host/api/v2/accounts/426/account-lead"
          }
        },
        "introducer": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/introducer",
            "related": "http://test.host/api/v2/accounts/426/introducer"
          }
        },
        "introducer-company": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/introducer-company",
            "related": "http://test.host/api/v2/accounts/426/introducer-company"
          }
        },
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/content-verticals",
            "related": "http://test.host/api/v2/accounts/426/content-verticals"
          }
        },
        "insights": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/insights",
            "related": "http://test.host/api/v2/accounts/426/insights"
          }
        },
        "entities": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/entities",
            "related": "http://test.host/api/v2/accounts/426/entities"
          }
        },
        "countries": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/countries",
            "related": "http://test.host/api/v2/accounts/426/countries"
          }
        },
        "sectors": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/sectors",
            "related": "http://test.host/api/v2/accounts/426/sectors"
          }
        },
        "introduced-accounts": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/introduced-accounts",
            "related": "http://test.host/api/v2/accounts/426/introduced-accounts"
          }
        },
        "premium-services": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/premium-services",
            "related": "http://test.host/api/v2/accounts/426/premium-services"
          }
        },
        "introduced-trending-insight-providers": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/introduced-trending-insight-providers",
            "related": "http://test.host/api/v2/accounts/426/introduced-trending-insight-providers"
          }
        },
        "introduced-trending-insights": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/introduced-trending-insights",
            "related": "http://test.host/api/v2/accounts/426/introduced-trending-insights"
          }
        },
        "introduced-trending-entities": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/introduced-trending-entities",
            "related": "http://test.host/api/v2/accounts/426/introduced-trending-entities"
          }
        },
        "filter-presets": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/filter-presets",
            "related": "http://test.host/api/v2/accounts/426/filter-presets"
          }
        },
        "external-reports": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/external-reports",
            "related": "http://test.host/api/v2/accounts/426/external-reports"
          }
        },
        "annotations": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/annotations",
            "related": "http://test.host/api/v2/accounts/426/annotations"
          }
        },
        "locker-items": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/locker-items",
            "related": "http://test.host/api/v2/accounts/426/locker-items"
          }
        },
        "muted-items": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/muted-items",
            "related": "http://test.host/api/v2/accounts/426/muted-items"
          }
        },
        "follows": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/follows",
            "related": "http://test.host/api/v2/accounts/426/follows"
          }
        },
        "following-accounts": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/following-accounts",
            "related": "http://test.host/api/v2/accounts/426/following-accounts"
          }
        },
        "push-notification-tokens": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/push-notification-tokens",
            "related": "http://test.host/api/v2/accounts/426/push-notification-tokens"
          }
        },
        "qva-reports": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/qva-reports",
            "related": "http://test.host/api/v2/accounts/426/qva-reports"
          }
        },
        "comments": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/comments",
            "related": "http://test.host/api/v2/accounts/426/comments"
          }
        },
        "shared-items": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/shared-items",
            "related": "http://test.host/api/v2/accounts/426/shared-items"
          }
        },
        "account-point": {
          "links": {
            "self": "http://test.host/api/v2/accounts/426/relationships/account-point",
            "related": "http://test.host/api/v2/accounts/426/account-point"
          }
        }
      }
    },
    {
      "id": "427",
      "type": "accounts",
      "links": {
        "self": "http://test.host/api/v2/accounts/427"
      },
      "attributes": {
        "custom-footer": null,
        "name": "Sonia Jamesina",
        "company-name": null,
        "avatar-url": {
          "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/427/small/test.png?1513677252",
          "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/427/medium/test.png?1513677252",
          "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/427/large/test.png?1513677252",
          "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/427/xlarge/test.png?1513677252"
        },
        "country": null,
        "joined-in-at": "2017-12-19T17:54:12.374+08:00",
        "title": null,
        "is-insight-provider": false,
        "is-client": true,
        "min-market-cap": null,
        "max-market-cap": null,
        "slug": "sonia-jamesina",
        "is-synthetic": false,
        "ip-rank": null,
        "funnel-status": null,
        "push-notification-setting": null,
        "insight-provider-type": null,
        "client-type": "professional",
        "is-dormant": false,
        "short-name": "Jerry",
        "gender": "plural",
        "has-changed-password": null,
        "mobile": null,
        "landline": null,
        "team-size": null,
        "trial-end-date": null,
        "areas-of-expertise": null,
        "activated": true,
        "is-compliance-officer": false,
        "has-distribution-restriction": false,
        "jurisdictions": [],
        "disclaimer": null,
        "team-leader": false,
        "is-introducer": false,
        "is-introducer-leader": false,
        "offer-premium-services": null,
        "premium-services-rate": null,
        "is-followed": false,
        "introduced-total-follows": 0,
        "compliance": null,
        "compliance-download-link": null,
        "is-muted": false,
        "total-unread-notifications": null,
        "client-agreed-at": null,
        "intercom-hash": null
      },
      "relationships": {
        "company": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/company",
            "related": "http://test.host/api/v2/accounts/427/company"
          }
        },
        "account-lead": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/account-lead",
            "related": "http://test.host/api/v2/accounts/427/account-lead"
          }
        },
        "introducer": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/introducer",
            "related": "http://test.host/api/v2/accounts/427/introducer"
          }
        },
        "introducer-company": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/introducer-company",
            "related": "http://test.host/api/v2/accounts/427/introducer-company"
          }
        },
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/content-verticals",
            "related": "http://test.host/api/v2/accounts/427/content-verticals"
          }
        },
        "insights": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/insights",
            "related": "http://test.host/api/v2/accounts/427/insights"
          }
        },
        "entities": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/entities",
            "related": "http://test.host/api/v2/accounts/427/entities"
          }
        },
        "countries": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/countries",
            "related": "http://test.host/api/v2/accounts/427/countries"
          }
        },
        "sectors": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/sectors",
            "related": "http://test.host/api/v2/accounts/427/sectors"
          }
        },
        "introduced-accounts": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/introduced-accounts",
            "related": "http://test.host/api/v2/accounts/427/introduced-accounts"
          }
        },
        "premium-services": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/premium-services",
            "related": "http://test.host/api/v2/accounts/427/premium-services"
          }
        },
        "introduced-trending-insight-providers": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/introduced-trending-insight-providers",
            "related": "http://test.host/api/v2/accounts/427/introduced-trending-insight-providers"
          }
        },
        "introduced-trending-insights": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/introduced-trending-insights",
            "related": "http://test.host/api/v2/accounts/427/introduced-trending-insights"
          }
        },
        "introduced-trending-entities": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/introduced-trending-entities",
            "related": "http://test.host/api/v2/accounts/427/introduced-trending-entities"
          }
        },
        "filter-presets": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/filter-presets",
            "related": "http://test.host/api/v2/accounts/427/filter-presets"
          }
        },
        "external-reports": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/external-reports",
            "related": "http://test.host/api/v2/accounts/427/external-reports"
          }
        },
        "annotations": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/annotations",
            "related": "http://test.host/api/v2/accounts/427/annotations"
          }
        },
        "locker-items": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/locker-items",
            "related": "http://test.host/api/v2/accounts/427/locker-items"
          }
        },
        "muted-items": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/muted-items",
            "related": "http://test.host/api/v2/accounts/427/muted-items"
          }
        },
        "follows": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/follows",
            "related": "http://test.host/api/v2/accounts/427/follows"
          }
        },
        "following-accounts": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/following-accounts",
            "related": "http://test.host/api/v2/accounts/427/following-accounts"
          }
        },
        "push-notification-tokens": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/push-notification-tokens",
            "related": "http://test.host/api/v2/accounts/427/push-notification-tokens"
          }
        },
        "qva-reports": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/qva-reports",
            "related": "http://test.host/api/v2/accounts/427/qva-reports"
          }
        },
        "comments": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/comments",
            "related": "http://test.host/api/v2/accounts/427/comments"
          }
        },
        "shared-items": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/shared-items",
            "related": "http://test.host/api/v2/accounts/427/shared-items"
          }
        },
        "account-point": {
          "links": {
            "self": "http://test.host/api/v2/accounts/427/relationships/account-point",
            "related": "http://test.host/api/v2/accounts/427/account-point"
          }
        }
      }
    }
  ],
  "meta": {
    "total-pages": 1,
    "record-count": 3
  },
  "links": {
    "first": "http://test.host/api/v2/accounts?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "last": "http://test.host/api/v2/accounts?page%5Bnumber%5D=1&page%5Bsize%5D=10"
  }
}

GET /api/v2/accounts/:id
Show an account

Examples

GET /api/v2/accounts/371
200
{
  "data": {
    "id": "371",
    "type": "accounts",
    "links": {
      "self": "http://test.host/api/v2/accounts/371"
    },
    "attributes": {
      "publication-setting": null,
      "custom-footer": null,
      "name": "Jade Boehm",
      "email": "26amanda@hayes.org",
      "company-name": null,
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/371/small/test.png?1513677227",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/371/medium/test.png?1513677227",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/371/large/test.png?1513677227",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/371/xlarge/test.png?1513677227"
      },
      "city": null,
      "country": null,
      "joined-in-at": "2017-12-19T17:53:47.238+08:00",
      "title": null,
      "education": [],
      "work-experience": [],
      "skills": [],
      "is-insight-provider": false,
      "is-client": true,
      "linked-in": null,
      "twitter": null,
      "website": null,
      "country-mandates": [
        "Singapore"
      ],
      "sector-mandates": [
        "Energy"
      ],
      "min-market-cap": null,
      "max-market-cap": null,
      "accreditations": {
        "professional-accredited-investor": false
      },
      "jurisdiction": "Singapore",
      "slug": "jade-boehm",
      "is-synthetic": false,
      "time-zone": "Europe",
      "summary": "Repudiandae sit totam ut nesciunt libero. Et quis sed tempora excepturi qui inventore aut. Iure illo nihil aut suscipit. Culpa minus modi eaque.",
      "vertical-subscriptions": [
        "Home 26"
      ],
      "ip-rank": null,
      "funnel-status": null,
      "communication-setting": {
        "private-message": true,
        "email-insight-comment": true,
        "email-insight-author": true,
        "email-comment-activity": true,
        "group-chat": true,
        "email-mention": true,
        "receive-alerts": true
      },
      "push-notification-setting": {
        "real-time-alert": true
      },
      "insight-provider-type": null,
      "client-type": "professional",
      "is-dormant": false,
      "short-name": "Jerry",
      "gender": "female",
      "has-changed-password": false,
      "mobile": null,
      "landline": null,
      "team-size": null,
      "interface-setting": {},
      "trial-end-date": null,
      "notifications-read-at": "2017-12-19T17:53:47.238+08:00",
      "areas-of-expertise": null,
      "activated": true,
      "is-compliance-officer": false,
      "has-distribution-restriction": false,
      "jurisdictions": [],
      "disclaimer": null,
      "team-leader": false,
      "is-introducer": false,
      "is-introducer-leader": false,
      "offer-premium-services": null,
      "premium-services-rate": null,
      "is-followed": false,
      "introduced-total-follows": 0,
      "compliance": null,
      "compliance-download-link": null,
      "is-muted": false,
      "expiring-insights-count": 0,
      "total-unread-message-groups": 0,
      "published-insights-count": 0,
      "followers-count": 0,
      "insight-views-count": 0,
      "unsubmitted-insights-count": 0,
      "under-review-insights-count": 0,
      "press-access-agreed-at": null,
      "total-unread-notifications": 0,
      "client-agreed-at": null,
      "published-external-reports-count": 0,
      "external-report-views-count": 0,
      "intercom-hash": "002c5eb3d9320131d1a371274f108048a349c3313c768445e8ac418860b275a3"
    },
    "relationships": {
      "company": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/company",
          "related": "http://test.host/api/v2/accounts/371/company"
        }
      },
      "account-lead": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/account-lead",
          "related": "http://test.host/api/v2/accounts/371/account-lead"
        }
      },
      "introducer": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/introducer",
          "related": "http://test.host/api/v2/accounts/371/introducer"
        }
      },
      "introducer-company": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/introducer-company",
          "related": "http://test.host/api/v2/accounts/371/introducer-company"
        }
      },
      "content-verticals": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/content-verticals",
          "related": "http://test.host/api/v2/accounts/371/content-verticals"
        }
      },
      "insights": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/insights",
          "related": "http://test.host/api/v2/accounts/371/insights"
        }
      },
      "entities": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/entities",
          "related": "http://test.host/api/v2/accounts/371/entities"
        }
      },
      "countries": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/countries",
          "related": "http://test.host/api/v2/accounts/371/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/sectors",
          "related": "http://test.host/api/v2/accounts/371/sectors"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/introduced-accounts",
          "related": "http://test.host/api/v2/accounts/371/introduced-accounts"
        }
      },
      "premium-services": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/premium-services",
          "related": "http://test.host/api/v2/accounts/371/premium-services"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/introduced-trending-insight-providers",
          "related": "http://test.host/api/v2/accounts/371/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/introduced-trending-insights",
          "related": "http://test.host/api/v2/accounts/371/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/introduced-trending-entities",
          "related": "http://test.host/api/v2/accounts/371/introduced-trending-entities"
        }
      },
      "filter-presets": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/filter-presets",
          "related": "http://test.host/api/v2/accounts/371/filter-presets"
        }
      },
      "external-reports": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/external-reports",
          "related": "http://test.host/api/v2/accounts/371/external-reports"
        }
      },
      "annotations": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/annotations",
          "related": "http://test.host/api/v2/accounts/371/annotations"
        }
      },
      "locker-items": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/locker-items",
          "related": "http://test.host/api/v2/accounts/371/locker-items"
        }
      },
      "muted-items": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/muted-items",
          "related": "http://test.host/api/v2/accounts/371/muted-items"
        }
      },
      "follows": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/follows",
          "related": "http://test.host/api/v2/accounts/371/follows"
        }
      },
      "following-accounts": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/following-accounts",
          "related": "http://test.host/api/v2/accounts/371/following-accounts"
        }
      },
      "push-notification-tokens": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/push-notification-tokens",
          "related": "http://test.host/api/v2/accounts/371/push-notification-tokens"
        }
      },
      "qva-reports": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/qva-reports",
          "related": "http://test.host/api/v2/accounts/371/qva-reports"
        }
      },
      "comments": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/comments",
          "related": "http://test.host/api/v2/accounts/371/comments"
        }
      },
      "shared-items": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/shared-items",
          "related": "http://test.host/api/v2/accounts/371/shared-items"
        }
      },
      "account-point": {
        "links": {
          "self": "http://test.host/api/v2/accounts/371/relationships/account-point",
          "related": "http://test.host/api/v2/accounts/371/account-point"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/accounts/:id
Update an account

Examples

PATCH /api/v2/accounts/394
{
  "data": {
    "id": "394",
    "type": "accounts",
    "attributes": {
      "name": "Rubye Beier I",
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/small/test.png?1513677233",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/medium/test.png?1513677233",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/large/test.png?1513677233",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/xlarge/test.png?1513677233"
      },
      "title": "The Boss",
      "company-name": null,
      "country": null,
      "slug": "rubye-beier-i",
      "joined-in-at": "2017-12-19 17:53:53 +0800",
      "is-insight-provider": false,
      "is-client": true,
      "is-synthetic": false,
      "areas-of-expertise": null,
      "communication-setting": {
        "email-insight-comment": true
      }
    },
    "relationships": {}
  }
}
200
{
  "data": {
    "id": "394",
    "type": "accounts",
    "links": {
      "self": "http://test.host/api/v2/accounts/394"
    },
    "attributes": {
      "publication-setting": null,
      "custom-footer": null,
      "name": "Rubye Beier I",
      "email": "49favian@runolfonleuschke.co",
      "company-name": null,
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/small/test.png?1513677233",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/medium/test.png?1513677233",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/large/test.png?1513677233",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/xlarge/test.png?1513677233"
      },
      "city": null,
      "country": null,
      "joined-in-at": "2017-12-19T17:53:53.663+08:00",
      "title": "The Boss",
      "education": [],
      "work-experience": [],
      "skills": [],
      "is-insight-provider": false,
      "is-client": true,
      "linked-in": null,
      "twitter": null,
      "website": null,
      "country-mandates": [
        "Singapore"
      ],
      "sector-mandates": [
        "Energy"
      ],
      "min-market-cap": null,
      "max-market-cap": null,
      "accreditations": {
        "professional-accredited-investor": "false"
      },
      "jurisdiction": "Singapore",
      "slug": "rubye-beier-i",
      "is-synthetic": false,
      "time-zone": "Asia-Pacific",
      "summary": "Aliquid accusamus voluptates architecto. Nihil eius sed iusto accusamus omnis dolores dolorem. Et tempore aut laboriosam voluptates consequatur non quis.",
      "vertical-subscriptions": [
        "Baby & Movies 49"
      ],
      "ip-rank": null,
      "funnel-status": null,
      "communication-setting": {
        "private-message": true,
        "email-insight-comment": true,
        "email-insight-author": true,
        "email-comment-activity": true,
        "group-chat": true,
        "email-mention": true,
        "receive-alerts": true
      },
      "push-notification-setting": {
        "real-time-alert": true
      },
      "insight-provider-type": null,
      "client-type": "professional",
      "is-dormant": false,
      "short-name": "Jerry",
      "gender": "plural",
      "has-changed-password": false,
      "mobile": null,
      "landline": null,
      "team-size": null,
      "interface-setting": {},
      "trial-end-date": null,
      "notifications-read-at": "2017-12-19T17:53:53.663+08:00",
      "areas-of-expertise": null,
      "activated": true,
      "is-compliance-officer": false,
      "has-distribution-restriction": false,
      "jurisdictions": [],
      "disclaimer": null,
      "team-leader": false,
      "is-introducer": false,
      "is-introducer-leader": false,
      "offer-premium-services": null,
      "premium-services-rate": null,
      "is-followed": false,
      "introduced-total-follows": 0,
      "compliance": null,
      "compliance-download-link": null,
      "is-muted": false,
      "expiring-insights-count": 0,
      "total-unread-message-groups": 0,
      "published-insights-count": 0,
      "followers-count": 0,
      "insight-views-count": 0,
      "unsubmitted-insights-count": 0,
      "under-review-insights-count": 0,
      "press-access-agreed-at": null,
      "total-unread-notifications": 0,
      "client-agreed-at": null,
      "published-external-reports-count": 0,
      "external-report-views-count": 0,
      "intercom-hash": "f2c8f75b318eec8e6ba3acfb95ef23c0097de0c7b4b5dbeb3af0ca473f141be1"
    },
    "relationships": {
      "company": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/company",
          "related": "http://test.host/api/v2/accounts/394/company"
        }
      },
      "account-lead": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/account-lead",
          "related": "http://test.host/api/v2/accounts/394/account-lead"
        }
      },
      "introducer": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introducer",
          "related": "http://test.host/api/v2/accounts/394/introducer"
        }
      },
      "introducer-company": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introducer-company",
          "related": "http://test.host/api/v2/accounts/394/introducer-company"
        }
      },
      "content-verticals": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/content-verticals",
          "related": "http://test.host/api/v2/accounts/394/content-verticals"
        }
      },
      "insights": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/insights",
          "related": "http://test.host/api/v2/accounts/394/insights"
        }
      },
      "entities": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/entities",
          "related": "http://test.host/api/v2/accounts/394/entities"
        }
      },
      "countries": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/countries",
          "related": "http://test.host/api/v2/accounts/394/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/sectors",
          "related": "http://test.host/api/v2/accounts/394/sectors"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introduced-accounts",
          "related": "http://test.host/api/v2/accounts/394/introduced-accounts"
        }
      },
      "premium-services": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/premium-services",
          "related": "http://test.host/api/v2/accounts/394/premium-services"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introduced-trending-insight-providers",
          "related": "http://test.host/api/v2/accounts/394/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introduced-trending-insights",
          "related": "http://test.host/api/v2/accounts/394/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introduced-trending-entities",
          "related": "http://test.host/api/v2/accounts/394/introduced-trending-entities"
        }
      },
      "filter-presets": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/filter-presets",
          "related": "http://test.host/api/v2/accounts/394/filter-presets"
        }
      },
      "external-reports": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/external-reports",
          "related": "http://test.host/api/v2/accounts/394/external-reports"
        }
      },
      "annotations": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/annotations",
          "related": "http://test.host/api/v2/accounts/394/annotations"
        }
      },
      "locker-items": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/locker-items",
          "related": "http://test.host/api/v2/accounts/394/locker-items"
        }
      },
      "muted-items": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/muted-items",
          "related": "http://test.host/api/v2/accounts/394/muted-items"
        }
      },
      "follows": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/follows",
          "related": "http://test.host/api/v2/accounts/394/follows"
        }
      },
      "following-accounts": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/following-accounts",
          "related": "http://test.host/api/v2/accounts/394/following-accounts"
        }
      },
      "push-notification-tokens": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/push-notification-tokens",
          "related": "http://test.host/api/v2/accounts/394/push-notification-tokens"
        }
      },
      "qva-reports": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/qva-reports",
          "related": "http://test.host/api/v2/accounts/394/qva-reports"
        }
      },
      "comments": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/comments",
          "related": "http://test.host/api/v2/accounts/394/comments"
        }
      },
      "shared-items": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/shared-items",
          "related": "http://test.host/api/v2/accounts/394/shared-items"
        }
      },
      "account-point": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/account-point",
          "related": "http://test.host/api/v2/accounts/394/account-point"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Account information

Validations:

  • Must be a Hash

data[old-password]
optional

Required if changing password

Validations:

  • Must be a String

data[password]
optional

Required if changing password (new password to use)

Validations:

  • Must be a String

data[password-confirmation]
optional

Required if changing password (confirm new password to use)

Validations:

  • Must be a String

data[name]
optional

Account's name

Validations:

  • Must be a String

data[company-name]
optional

Account's company name

Validations:

  • Must be a String

data[city]
optional

Account's city

Validations:

  • Must be a String

data[country]
optional

Account's country

Validations:

  • Must be a String

data[title]
optional

Account's title/headline

Validations:

  • Must be a String

data[summary]
optional

Account's short description/mini biography

Validations:

  • Must be a String

data[education]
optional

Account's educational background

Validations:

  • Must be an array of any type

data[work-experience]
optional

Account's work experiences

Validations:

  • Must be an array of any type

data[skills]
optional

Account's skills/expertise (Insight Providers only)

Validations:

  • Must be an array of any type

data[country-mandates]
optional

Account's country mandates (Clients only)

Validations:

  • Must be an array of any type

data[sector-mandates]
optional

Account's sector mandates (Clients only)

Validations:

  • Must be an array of any type

data[accreditations]
optional

Account's professional accreditations (Clients only)

Validations:

  • Must be a Hash

data[jurisdiction]
optional

Account's country of jusrisdiction (Clients only)

Validations:

  • Must be a String

data[time-zone]
optional

Account's time zone (Clients only)

Validations:

  • Must be a String

data[communication-setting]
optional

Account's email communication settings

Validations:

  • Must be a Hash

data[communication-setting][reading-list-delivery]
optional

Account's reading list delivery (Clients only)

Validations:

  • Must be one of: daily, weekly, never.

data[communication-setting][real-time-alert]
optional

Account's real time email alerts (Clients only)

Validations:

  • Must be one of: true, false.

data[communication-setting][peer-review-frequency]
optional

Account's peer reviews frequency (Insight Providers only)

Validations:

  • Must be one of: daily, never.

data[profile-photo]
optional

Account's profile photo file in data URL format

Validations:

  • Must be a String

data[profile-photo-file-name]
optional

Account's profile photo file name

Validations:

  • Must be a String


PATCH /api/v2/accounts/:id/follow
Follow Insight Provider Account

Examples

PATCH /api/v2/accounts/347/follow
{}
200
{
  "data": {
    "id": "347",
    "type": "accounts",
    "links": {
      "self": "/api/v2/accounts/347"
    },
    "attributes": {
      "custom-footer": null,
      "name": "Maximus Jackson",
      "company-name": null,
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/347/small/test.png?1513677220",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/347/medium/test.png?1513677220",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/347/large/test.png?1513677220",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/347/xlarge/test.png?1513677220"
      },
      "country": null,
      "joined-in-at": "2017-12-19T17:53:40.415+08:00",
      "title": null,
      "is-insight-provider": true,
      "is-client": false,
      "min-market-cap": null,
      "max-market-cap": null,
      "slug": "maximus-jackson",
      "is-synthetic": false,
      "ip-rank": null,
      "funnel-status": null,
      "push-notification-setting": null,
      "insight-provider-type": "external",
      "client-type": null,
      "is-dormant": false,
      "short-name": "Jerry",
      "gender": "male",
      "has-changed-password": null,
      "mobile": null,
      "landline": null,
      "team-size": null,
      "trial-end-date": null,
      "areas-of-expertise": {
        "industry-group-primary": null,
        "industry-group-secondary": null,
        "industry-primary": null,
        "industry-secondary": null,
        "market-caps": "Any",
        "sector-generalist": true,
        "country-generalist": true,
        "asset-class-primary": "Equities",
        "content-vertical-generalist": true
      },
      "activated": true,
      "is-compliance-officer": false,
      "has-distribution-restriction": false,
      "jurisdictions": [],
      "disclaimer": null,
      "team-leader": false,
      "is-introducer": false,
      "is-introducer-leader": false,
      "offer-premium-services": false,
      "premium-services-rate": null,
      "total-watched-entities": 0,
      "total-followed-insight-providers": 0,
      "total-alerts": 0,
      "last-active-at": null,
      "total-activities": 0,
      "is-followed": true,
      "introduced-total-follows": 0,
      "compliance": null,
      "compliance-download-link": null,
      "is-muted": false,
      "total-unread-notifications": null,
      "client-agreed-at": null,
      "intercom-hash": null
    },
    "relationships": {
      "company": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/company",
          "related": "/api/v2/accounts/347/company"
        }
      },
      "account-lead": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/account-lead",
          "related": "/api/v2/accounts/347/account-lead"
        }
      },
      "introducer": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introducer",
          "related": "/api/v2/accounts/347/introducer"
        }
      },
      "introducer-company": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introducer-company",
          "related": "/api/v2/accounts/347/introducer-company"
        }
      },
      "content-verticals": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/content-verticals",
          "related": "/api/v2/accounts/347/content-verticals"
        }
      },
      "insights": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/insights",
          "related": "/api/v2/accounts/347/insights"
        }
      },
      "entities": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/entities",
          "related": "/api/v2/accounts/347/entities"
        }
      },
      "countries": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/countries",
          "related": "/api/v2/accounts/347/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/sectors",
          "related": "/api/v2/accounts/347/sectors"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introduced-accounts",
          "related": "/api/v2/accounts/347/introduced-accounts"
        }
      },
      "premium-services": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/premium-services",
          "related": "/api/v2/accounts/347/premium-services"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introduced-trending-insight-providers",
          "related": "/api/v2/accounts/347/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introduced-trending-insights",
          "related": "/api/v2/accounts/347/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introduced-trending-entities",
          "related": "/api/v2/accounts/347/introduced-trending-entities"
        }
      },
      "filter-presets": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/filter-presets",
          "related": "/api/v2/accounts/347/filter-presets"
        }
      },
      "external-reports": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/external-reports",
          "related": "/api/v2/accounts/347/external-reports"
        }
      },
      "annotations": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/annotations",
          "related": "/api/v2/accounts/347/annotations"
        }
      },
      "locker-items": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/locker-items",
          "related": "/api/v2/accounts/347/locker-items"
        }
      },
      "muted-items": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/muted-items",
          "related": "/api/v2/accounts/347/muted-items"
        }
      },
      "follows": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/follows",
          "related": "/api/v2/accounts/347/follows"
        }
      },
      "following-accounts": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/following-accounts",
          "related": "/api/v2/accounts/347/following-accounts"
        }
      },
      "push-notification-tokens": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/push-notification-tokens",
          "related": "/api/v2/accounts/347/push-notification-tokens"
        }
      },
      "qva-reports": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/qva-reports",
          "related": "/api/v2/accounts/347/qva-reports"
        }
      },
      "comments": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/comments",
          "related": "/api/v2/accounts/347/comments"
        }
      },
      "shared-items": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/shared-items",
          "related": "/api/v2/accounts/347/shared-items"
        }
      },
      "account-point": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/account-point",
          "related": "/api/v2/accounts/347/account-point"
        }
      }
    }
  }
}

Params

Param name Description
id
required

account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/accounts/:id/unfollow
Unfollow Insight Provider Account

Examples

PATCH /api/v2/accounts/420/unfollow
{}
200
{
  "data": {
    "id": "420",
    "type": "accounts",
    "links": {
      "self": "/api/v2/accounts/420"
    },
    "attributes": {
      "custom-footer": null,
      "name": "Maximus Jackson",
      "company-name": null,
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/420/small/test.png?1513677248",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/420/medium/test.png?1513677248",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/420/large/test.png?1513677248",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/420/xlarge/test.png?1513677248"
      },
      "country": null,
      "joined-in-at": "2017-12-19T17:54:08.960+08:00",
      "title": null,
      "is-insight-provider": true,
      "is-client": false,
      "min-market-cap": null,
      "max-market-cap": null,
      "slug": "maximus-jackson",
      "is-synthetic": false,
      "ip-rank": null,
      "funnel-status": null,
      "push-notification-setting": null,
      "insight-provider-type": "external",
      "client-type": null,
      "is-dormant": false,
      "short-name": "Jerry",
      "gender": "female",
      "has-changed-password": null,
      "mobile": null,
      "landline": null,
      "team-size": null,
      "trial-end-date": null,
      "areas-of-expertise": {
        "industry-group-primary": null,
        "industry-group-secondary": null,
        "industry-primary": null,
        "industry-secondary": null,
        "market-caps": "Any",
        "sector-generalist": true,
        "country-generalist": true,
        "asset-class-primary": "Equities",
        "content-vertical-generalist": true
      },
      "activated": true,
      "is-compliance-officer": false,
      "has-distribution-restriction": false,
      "jurisdictions": [],
      "disclaimer": null,
      "team-leader": false,
      "is-introducer": false,
      "is-introducer-leader": false,
      "offer-premium-services": false,
      "premium-services-rate": null,
      "total-watched-entities": 0,
      "total-followed-insight-providers": 0,
      "total-alerts": 0,
      "last-active-at": null,
      "total-activities": 0,
      "is-followed": false,
      "introduced-total-follows": 0,
      "compliance": null,
      "compliance-download-link": null,
      "is-muted": false,
      "total-unread-notifications": null,
      "client-agreed-at": null,
      "intercom-hash": null
    },
    "relationships": {
      "company": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/company",
          "related": "/api/v2/accounts/420/company"
        }
      },
      "account-lead": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/account-lead",
          "related": "/api/v2/accounts/420/account-lead"
        }
      },
      "introducer": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/introducer",
          "related": "/api/v2/accounts/420/introducer"
        }
      },
      "introducer-company": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/introducer-company",
          "related": "/api/v2/accounts/420/introducer-company"
        }
      },
      "content-verticals": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/content-verticals",
          "related": "/api/v2/accounts/420/content-verticals"
        }
      },
      "insights": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/insights",
          "related": "/api/v2/accounts/420/insights"
        }
      },
      "entities": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/entities",
          "related": "/api/v2/accounts/420/entities"
        }
      },
      "countries": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/countries",
          "related": "/api/v2/accounts/420/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/sectors",
          "related": "/api/v2/accounts/420/sectors"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/introduced-accounts",
          "related": "/api/v2/accounts/420/introduced-accounts"
        }
      },
      "premium-services": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/premium-services",
          "related": "/api/v2/accounts/420/premium-services"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/introduced-trending-insight-providers",
          "related": "/api/v2/accounts/420/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/introduced-trending-insights",
          "related": "/api/v2/accounts/420/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/introduced-trending-entities",
          "related": "/api/v2/accounts/420/introduced-trending-entities"
        }
      },
      "filter-presets": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/filter-presets",
          "related": "/api/v2/accounts/420/filter-presets"
        }
      },
      "external-reports": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/external-reports",
          "related": "/api/v2/accounts/420/external-reports"
        }
      },
      "annotations": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/annotations",
          "related": "/api/v2/accounts/420/annotations"
        }
      },
      "locker-items": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/locker-items",
          "related": "/api/v2/accounts/420/locker-items"
        }
      },
      "muted-items": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/muted-items",
          "related": "/api/v2/accounts/420/muted-items"
        }
      },
      "follows": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/follows",
          "related": "/api/v2/accounts/420/follows"
        }
      },
      "following-accounts": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/following-accounts",
          "related": "/api/v2/accounts/420/following-accounts"
        }
      },
      "push-notification-tokens": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/push-notification-tokens",
          "related": "/api/v2/accounts/420/push-notification-tokens"
        }
      },
      "qva-reports": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/qva-reports",
          "related": "/api/v2/accounts/420/qva-reports"
        }
      },
      "comments": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/comments",
          "related": "/api/v2/accounts/420/comments"
        }
      },
      "shared-items": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/shared-items",
          "related": "/api/v2/accounts/420/shared-items"
        }
      },
      "account-point": {
        "links": {
          "self": "/api/v2/accounts/420/relationships/account-point",
          "related": "/api/v2/accounts/420/account-point"
        }
      }
    }
  }
}

Params

Param name Description
id
required

account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/accounts/:id/follow_accounts
Add followings to the account

Examples

PATCH /api/v2/accounts/391/follow-accounts
{
  "data": {
    "id": "391",
    "type": "accounts",
    "relationships": {
      "following-accounts": {
        "data": [
          {
            "type": "accounts",
            "id": 392
          },
          {
            "type": "accounts",
            "id": 393
          }
        ]
      }
    }
  }
}
200
{
  "data": {
    "id": "391",
    "type": "accounts",
    "links": {
      "self": "/api/v2/accounts/391"
    },
    "attributes": {
      "custom-footer": null,
      "name": "Shaina Runolfsson III",
      "company-name": null,
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/391/small/test.png?1513677232",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/391/medium/test.png?1513677232",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/391/large/test.png?1513677232",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/391/xlarge/test.png?1513677232"
      },
      "country": null,
      "joined-in-at": "2017-12-19T17:53:52.834+08:00",
      "title": null,
      "is-insight-provider": false,
      "is-client": true,
      "min-market-cap": null,
      "max-market-cap": null,
      "slug": "shaina-runolfsson-iii",
      "is-synthetic": false,
      "ip-rank": null,
      "funnel-status": null,
      "push-notification-setting": {
        "real-time-alert": true
      },
      "insight-provider-type": null,
      "client-type": "professional",
      "is-dormant": false,
      "short-name": "Jerry",
      "gender": "female",
      "has-changed-password": false,
      "mobile": null,
      "landline": null,
      "team-size": null,
      "trial-end-date": null,
      "areas-of-expertise": null,
      "activated": true,
      "is-compliance-officer": false,
      "has-distribution-restriction": false,
      "jurisdictions": [],
      "disclaimer": null,
      "team-leader": false,
      "is-introducer": false,
      "is-introducer-leader": false,
      "offer-premium-services": null,
      "premium-services-rate": null,
      "total-watched-entities": 0,
      "total-followed-insight-providers": 0,
      "total-alerts": 0,
      "last-active-at": null,
      "total-activities": 0,
      "is-followed": false,
      "introduced-total-follows": 0,
      "compliance": null,
      "compliance-download-link": null,
      "is-muted": false,
      "total-unread-notifications": 0,
      "client-agreed-at": null,
      "intercom-hash": "d30c31a1faa38f8192277be0fdde55fd5234937ead601e7ba61f8fa47f274bde"
    },
    "relationships": {
      "company": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/company",
          "related": "/api/v2/accounts/391/company"
        }
      },
      "account-lead": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/account-lead",
          "related": "/api/v2/accounts/391/account-lead"
        }
      },
      "introducer": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introducer",
          "related": "/api/v2/accounts/391/introducer"
        }
      },
      "introducer-company": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introducer-company",
          "related": "/api/v2/accounts/391/introducer-company"
        }
      },
      "content-verticals": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/content-verticals",
          "related": "/api/v2/accounts/391/content-verticals"
        }
      },
      "insights": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/insights",
          "related": "/api/v2/accounts/391/insights"
        }
      },
      "entities": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/entities",
          "related": "/api/v2/accounts/391/entities"
        }
      },
      "countries": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/countries",
          "related": "/api/v2/accounts/391/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/sectors",
          "related": "/api/v2/accounts/391/sectors"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introduced-accounts",
          "related": "/api/v2/accounts/391/introduced-accounts"
        }
      },
      "premium-services": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/premium-services",
          "related": "/api/v2/accounts/391/premium-services"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introduced-trending-insight-providers",
          "related": "/api/v2/accounts/391/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introduced-trending-insights",
          "related": "/api/v2/accounts/391/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introduced-trending-entities",
          "related": "/api/v2/accounts/391/introduced-trending-entities"
        }
      },
      "filter-presets": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/filter-presets",
          "related": "/api/v2/accounts/391/filter-presets"
        }
      },
      "external-reports": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/external-reports",
          "related": "/api/v2/accounts/391/external-reports"
        }
      },
      "annotations": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/annotations",
          "related": "/api/v2/accounts/391/annotations"
        }
      },
      "locker-items": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/locker-items",
          "related": "/api/v2/accounts/391/locker-items"
        }
      },
      "muted-items": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/muted-items",
          "related": "/api/v2/accounts/391/muted-items"
        }
      },
      "follows": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/follows",
          "related": "/api/v2/accounts/391/follows"
        }
      },
      "following-accounts": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/following-accounts",
          "related": "/api/v2/accounts/391/following-accounts"
        }
      },
      "push-notification-tokens": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/push-notification-tokens",
          "related": "/api/v2/accounts/391/push-notification-tokens"
        }
      },
      "qva-reports": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/qva-reports",
          "related": "/api/v2/accounts/391/qva-reports"
        }
      },
      "comments": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/comments",
          "related": "/api/v2/accounts/391/comments"
        }
      },
      "shared-items": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/shared-items",
          "related": "/api/v2/accounts/391/shared-items"
        }
      },
      "account-point": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/account-point",
          "related": "/api/v2/accounts/391/account-point"
        }
      }
    }
  }
}

Params

Param name Description
id
required

account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Account information

Validations:

  • Must be a Hash

data[old-password]
optional

Required if changing password

Validations:

  • Must be a String

data[password]
optional

Required if changing password (new password to use)

Validations:

  • Must be a String

data[password-confirmation]
optional

Required if changing password (confirm new password to use)

Validations:

  • Must be a String

data[name]
optional

Account's name

Validations:

  • Must be a String

data[company-name]
optional

Account's company name

Validations:

  • Must be a String

data[city]
optional

Account's city

Validations:

  • Must be a String

data[country]
optional

Account's country

Validations:

  • Must be a String

data[title]
optional

Account's title/headline

Validations:

  • Must be a String

data[summary]
optional

Account's short description/mini biography

Validations:

  • Must be a String

data[education]
optional

Account's educational background

Validations:

  • Must be an array of any type

data[work-experience]
optional

Account's work experiences

Validations:

  • Must be an array of any type

data[skills]
optional

Account's skills/expertise (Insight Providers only)

Validations:

  • Must be an array of any type

data[country-mandates]
optional

Account's country mandates (Clients only)

Validations:

  • Must be an array of any type

data[sector-mandates]
optional

Account's sector mandates (Clients only)

Validations:

  • Must be an array of any type

data[accreditations]
optional

Account's professional accreditations (Clients only)

Validations:

  • Must be a Hash

data[jurisdiction]
optional

Account's country of jusrisdiction (Clients only)

Validations:

  • Must be a String

data[time-zone]
optional

Account's time zone (Clients only)

Validations:

  • Must be a String

data[communication-setting]
optional

Account's email communication settings

Validations:

  • Must be a Hash

data[communication-setting][reading-list-delivery]
optional

Account's reading list delivery (Clients only)

Validations:

  • Must be one of: daily, weekly, never.

data[communication-setting][real-time-alert]
optional

Account's real time email alerts (Clients only)

Validations:

  • Must be one of: true, false.

data[communication-setting][peer-review-frequency]
optional

Account's peer reviews frequency (Insight Providers only)

Validations:

  • Must be one of: daily, never.

data[profile-photo]
optional

Account's profile photo file in data URL format

Validations:

  • Must be a String

data[profile-photo-file-name]
optional

Account's profile photo file name

Validations:

  • Must be a String