Skip to main content
GET
/
companies
/
{company_id}
Get a company
curl --request GET \
  --url https://api-dev.narrative.io/companies/{company_id}
{
  "company_id": 42,
  "slug": "acm",
  "name": "ACM",
  "long_description": "The Acme Corporation is an ironic name for the fictional corporation, appearing in the Road Runner/Wile E. Coyote animated shorts, where it was used as a running gag.",
  "short_description": "American Company that Manufactures Everything",
  "contact_email": "[email protected]",
  "data_shop_url": "https://shop.acm.io",
  "twitter_link": "https://twitter.com/acm_company",
  "linkedin_link": "https://www.linkedin.com/company/acm_company",
  "image_url": null,
  "visibility": "visible",
  "status": "active",
  "website": null
}

Path Parameters

company_id
integer<int64>
required

The id of an existing company

Response

200 - application/json

OK

company_id
integer

Unique identifier of an existing company.

Example:

7

slug
string

Unique id for the company

name
string

Name of the company

short_description
string

A short description of the company

long_description
string

The complete description of the company

contact_email
string

Email contact

website
string

The url of the website of the company

data_shop_url
string

The url of the data shop of the company

Twitter account

LinkedIn account

image_url
string

The url of the logo of the company

location
string

The geographical location of the company

size
string

The number of employees

visibility
enum<string>
Available options:
invisible,
visible,
invisible_in_discover
status
enum<string>
Available options:
active,
deleted,
pending