GET /api/v1/companies
List of companies

Examples

GET /api/v2/companies
200
{
  "data": [
    {
      "id": "59",
      "type": "companies",
      "links": {
        "self": "http://test.host/api/v2/companies/59"
      },
      "attributes": {
        "name": "APPLE INC",
        "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": "apple-inc",
        "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:51.794+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/59/relationships/accounts",
            "related": "http://test.host/api/v2/companies/59/accounts"
          }
        },
        "insights": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/insights",
            "related": "http://test.host/api/v2/companies/59/insights"
          }
        },
        "external-reports": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/external-reports",
            "related": "http://test.host/api/v2/companies/59/external-reports"
          }
        },
        "restricted-insight-providers": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/restricted-insight-providers",
            "related": "http://test.host/api/v2/companies/59/restricted-insight-providers"
          }
        },
        "introduced-accounts": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/introduced-accounts",
            "related": "http://test.host/api/v2/companies/59/introduced-accounts"
          }
        },
        "introduced-trending-insight-providers": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/introduced-trending-insight-providers",
            "related": "http://test.host/api/v2/companies/59/introduced-trending-insight-providers"
          }
        },
        "introduced-trending-insights": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/introduced-trending-insights",
            "related": "http://test.host/api/v2/companies/59/introduced-trending-insights"
          }
        },
        "introduced-trending-entities": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/introduced-trending-entities",
            "related": "http://test.host/api/v2/companies/59/introduced-trending-entities"
          }
        },
        "entities": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/entities",
            "related": "http://test.host/api/v2/companies/59/entities"
          }
        },
        "countries": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/countries",
            "related": "http://test.host/api/v2/companies/59/countries"
          }
        },
        "sectors": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/sectors",
            "related": "http://test.host/api/v2/companies/59/sectors"
          }
        },
        "analysts": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/analysts",
            "related": "http://test.host/api/v2/companies/59/analysts"
          }
        },
        "clients": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/clients",
            "related": "http://test.host/api/v2/companies/59/clients"
          }
        },
        "team-members": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/team-members",
            "related": "http://test.host/api/v2/companies/59/team-members"
          }
        },
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/companies/59/relationships/content-verticals",
            "related": "http://test.host/api/v2/companies/59/content-verticals"
          }
        }
      }
    },
    {
      "id": "60",
      "type": "companies",
      "links": {
        "self": "http://test.host/api/v2/companies/60"
      },
      "attributes": {
        "name": "GOOGLE INC",
        "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": "google-inc",
        "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:51.934+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/60/relationships/accounts",
            "related": "http://test.host/api/v2/companies/60/accounts"
          }
        },
        "insights": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/insights",
            "related": "http://test.host/api/v2/companies/60/insights"
          }
        },
        "external-reports": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/external-reports",
            "related": "http://test.host/api/v2/companies/60/external-reports"
          }
        },
        "restricted-insight-providers": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/restricted-insight-providers",
            "related": "http://test.host/api/v2/companies/60/restricted-insight-providers"
          }
        },
        "introduced-accounts": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/introduced-accounts",
            "related": "http://test.host/api/v2/companies/60/introduced-accounts"
          }
        },
        "introduced-trending-insight-providers": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/introduced-trending-insight-providers",
            "related": "http://test.host/api/v2/companies/60/introduced-trending-insight-providers"
          }
        },
        "introduced-trending-insights": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/introduced-trending-insights",
            "related": "http://test.host/api/v2/companies/60/introduced-trending-insights"
          }
        },
        "introduced-trending-entities": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/introduced-trending-entities",
            "related": "http://test.host/api/v2/companies/60/introduced-trending-entities"
          }
        },
        "entities": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/entities",
            "related": "http://test.host/api/v2/companies/60/entities"
          }
        },
        "countries": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/countries",
            "related": "http://test.host/api/v2/companies/60/countries"
          }
        },
        "sectors": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/sectors",
            "related": "http://test.host/api/v2/companies/60/sectors"
          }
        },
        "analysts": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/analysts",
            "related": "http://test.host/api/v2/companies/60/analysts"
          }
        },
        "clients": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/clients",
            "related": "http://test.host/api/v2/companies/60/clients"
          }
        },
        "team-members": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/team-members",
            "related": "http://test.host/api/v2/companies/60/team-members"
          }
        },
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/companies/60/relationships/content-verticals",
            "related": "http://test.host/api/v2/companies/60/content-verticals"
          }
        }
      }
    },
    {
      "id": "61",
      "type": "companies",
      "links": {
        "self": "http://test.host/api/v2/companies/61"
      },
      "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:51.941+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/61/relationships/accounts",
            "related": "http://test.host/api/v2/companies/61/accounts"
          }
        },
        "insights": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/insights",
            "related": "http://test.host/api/v2/companies/61/insights"
          }
        },
        "external-reports": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/external-reports",
            "related": "http://test.host/api/v2/companies/61/external-reports"
          }
        },
        "restricted-insight-providers": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/restricted-insight-providers",
            "related": "http://test.host/api/v2/companies/61/restricted-insight-providers"
          }
        },
        "introduced-accounts": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/introduced-accounts",
            "related": "http://test.host/api/v2/companies/61/introduced-accounts"
          }
        },
        "introduced-trending-insight-providers": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/introduced-trending-insight-providers",
            "related": "http://test.host/api/v2/companies/61/introduced-trending-insight-providers"
          }
        },
        "introduced-trending-insights": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/introduced-trending-insights",
            "related": "http://test.host/api/v2/companies/61/introduced-trending-insights"
          }
        },
        "introduced-trending-entities": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/introduced-trending-entities",
            "related": "http://test.host/api/v2/companies/61/introduced-trending-entities"
          }
        },
        "entities": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/entities",
            "related": "http://test.host/api/v2/companies/61/entities"
          }
        },
        "countries": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/countries",
            "related": "http://test.host/api/v2/companies/61/countries"
          }
        },
        "sectors": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/sectors",
            "related": "http://test.host/api/v2/companies/61/sectors"
          }
        },
        "analysts": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/analysts",
            "related": "http://test.host/api/v2/companies/61/analysts"
          }
        },
        "clients": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/clients",
            "related": "http://test.host/api/v2/companies/61/clients"
          }
        },
        "team-members": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/team-members",
            "related": "http://test.host/api/v2/companies/61/team-members"
          }
        },
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/companies/61/relationships/content-verticals",
            "related": "http://test.host/api/v2/companies/61/content-verticals"
          }
        }
      }
    }
  ],
  "meta": {
    "total-pages": 1,
    "record-count": 3
  },
  "links": {
    "first": "http://test.host/api/v2/companies?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "last": "http://test.host/api/v2/companies?page%5Bnumber%5D=1&page%5Bsize%5D=10"
  }
}

GET /api/v1/companies/:id
Show a company

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.


PATCH /api/v1/companies/:id
Update a company

Examples

PATCH /api/v2/companies/23
{
  "data": {
    "id": "23",
    "type": "companies",
    "attributes": {
      "name": "New Company Name",
      "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": {
        "country-generalist": true,
        "sector-generalist": true,
        "content-vertical-generalist": true,
        "asset-class-primary": "Equities",
        "market-caps": "Any"
      },
      "allow-ip-areas-of-expertise": true,
      "slug": "apple-inc",
      "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-29 10:42:43 +0800",
      "publish-under-company-name": false,
      "has-distribution-restriction": false,
      "jurisdictions": [],
      "disclaimer": null,
      "has-compliance-officer": true,
      "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": {}
  }
}
200
{
  "data": {
    "id": "23",
    "type": "companies",
    "links": {
      "self": "http://test.host/api/v2/companies/23"
    },
    "attributes": {
      "name": "New Company Name",
      "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": "new-company-name",
      "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:43.652+08:00",
      "publish-under-company-name": false,
      "has-distribution-restriction": false,
      "jurisdictions": [],
      "disclaimer": null,
      "has-compliance-officer": true,
      "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/23/relationships/accounts",
          "related": "http://test.host/api/v2/companies/23/accounts"
        }
      },
      "insights": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/insights",
          "related": "http://test.host/api/v2/companies/23/insights"
        }
      },
      "external-reports": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/external-reports",
          "related": "http://test.host/api/v2/companies/23/external-reports"
        }
      },
      "restricted-insight-providers": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/restricted-insight-providers",
          "related": "http://test.host/api/v2/companies/23/restricted-insight-providers"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/introduced-accounts",
          "related": "http://test.host/api/v2/companies/23/introduced-accounts"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/introduced-trending-insight-providers",
          "related": "http://test.host/api/v2/companies/23/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/introduced-trending-insights",
          "related": "http://test.host/api/v2/companies/23/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/introduced-trending-entities",
          "related": "http://test.host/api/v2/companies/23/introduced-trending-entities"
        }
      },
      "entities": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/entities",
          "related": "http://test.host/api/v2/companies/23/entities"
        }
      },
      "countries": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/countries",
          "related": "http://test.host/api/v2/companies/23/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/sectors",
          "related": "http://test.host/api/v2/companies/23/sectors"
        }
      },
      "analysts": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/analysts",
          "related": "http://test.host/api/v2/companies/23/analysts"
        }
      },
      "clients": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/clients",
          "related": "http://test.host/api/v2/companies/23/clients"
        }
      },
      "team-members": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/team-members",
          "related": "http://test.host/api/v2/companies/23/team-members"
        }
      },
      "content-verticals": {
        "links": {
          "self": "http://test.host/api/v2/companies/23/relationships/content-verticals",
          "related": "http://test.host/api/v2/companies/23/content-verticals"
        }
      }
    }
  }
}

Params

Param name Description
id
required

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


POST /api/v1/companies
Create a company


DELETE /api/v1/companies/:id
Delete a company

Params

Param name Description
id
required

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