Examples

GET /api/v2/companies/68
200
{
  "data": {
    "id": "68",
    "type": "companies",
    "links": {
      "self": "http://test.host/api/v2/companies/68"
    },
    "attributes": {
      "name": "Smartkarma",
      "publication-setting": null,
      "custom-footer": null,
      "accreditation": false,
      "title": null,
      "summary": null,
      "address": null,
      "city": null,
      "state": null,
      "country": null,
      "avatar-url": {
        "small": "https://assets.smartkarma.com/images/profile/default-company.png",
        "medium": "https://assets.smartkarma.com/images/profile/default-company.png",
        "large": "https://assets.smartkarma.com/images/profile/default-company.png",
        "xlarge": "https://assets.smartkarma.com/images/profile/default-company.png"
      },
      "disable-private-messages": false,
      "areas-of-expertise": {
        "market-caps": "Any",
        "sector-generalist": true,
        "country-generalist": true,
        "asset-class-primary": "Equities",
        "content-vertical-generalist": true
      },
      "allow-ip-areas-of-expertise": true,
      "slug": "smartkarma",
      "is-client": false,
      "is-insight-provider": false,
      "published-insights-count": 0,
      "disable-viewing-comments": false,
      "disable-posting-comments": false,
      "clients-count": 0,
      "analysts-count": 0,
      "created-at": "2017-08-29T10:42:52.729+08:00",
      "publish-under-company-name": false,
      "has-distribution-restriction": false,
      "jurisdictions": [],
      "disclaimer": null,
      "has-compliance-officer": false,
      "team-size": null,
      "postalcode": null,
      "is-issuer-paid": false,
      "published-external-reports-count": 0,
      "website": null,
      "linked-in": null,
      "twitter": null,
      "facebook": null,
      "introduced-total-follows": 0,
      "followers-count": 0,
      "insight-views-count": 0,
      "external-report-views-count": 0
    },
    "relationships": {
      "accounts": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/accounts",
          "related": "http://test.host/api/v2/companies/68/accounts"
        }
      },
      "insights": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/insights",
          "related": "http://test.host/api/v2/companies/68/insights"
        }
      },
      "external-reports": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/external-reports",
          "related": "http://test.host/api/v2/companies/68/external-reports"
        }
      },
      "restricted-insight-providers": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/restricted-insight-providers",
          "related": "http://test.host/api/v2/companies/68/restricted-insight-providers"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/introduced-accounts",
          "related": "http://test.host/api/v2/companies/68/introduced-accounts"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/introduced-trending-insight-providers",
          "related": "http://test.host/api/v2/companies/68/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/introduced-trending-insights",
          "related": "http://test.host/api/v2/companies/68/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/introduced-trending-entities",
          "related": "http://test.host/api/v2/companies/68/introduced-trending-entities"
        }
      },
      "entities": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/entities",
          "related": "http://test.host/api/v2/companies/68/entities"
        }
      },
      "countries": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/countries",
          "related": "http://test.host/api/v2/companies/68/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/sectors",
          "related": "http://test.host/api/v2/companies/68/sectors"
        }
      },
      "analysts": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/analysts",
          "related": "http://test.host/api/v2/companies/68/analysts"
        }
      },
      "clients": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/clients",
          "related": "http://test.host/api/v2/companies/68/clients"
        }
      },
      "team-members": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/team-members",
          "related": "http://test.host/api/v2/companies/68/team-members"
        }
      },
      "content-verticals": {
        "links": {
          "self": "http://test.host/api/v2/companies/68/relationships/content-verticals",
          "related": "http://test.host/api/v2/companies/68/content-verticals"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Company 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.