Access Tokens
Access Rules
Queries
Apps
Attributes
Authentication
- POSTAuthenticate a user based on a Stytch session token (B2B version)
- POSTRegister a user based on a Stytch session token (B2B)
- POSTReport whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side (B2B)
- POSTAuthenticate a user based on a Stytch session token
- POSTRegister a user based on a Stytch session token
- POSTReport whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side
Connections
Datasets
- GETGet datasets
- PUTUpdate a dataset
- POSTCreate a dataset
- GETGet a dataset
- PUTUpdate a dataset
- DELDelete a dataset
- PUTActivate a dataset
- POSTActivate a datasetdeprecated
- POSTTruncate a dataset
- GETSample a dataset
- DELDelete a sample
- GETGet admin info for a dataset
- GETSample a dataset (Admin)
- POSTUpdate a dataset's partition spec
- POSTPreview snapshot expirations
- PUTUpsert retention policies for a dataset
- POSTRequest Dataset Sample
- GETSampled Mappings
- POSTSuggest mappings
- GETGet dataset statistics
- GETGet detailed statistics
- PUTCreate or Update detailed statistics
- POSTSubmit recalculation
- POSTIngest a file
- GETFiles added
- GETFind snapshots
- GETMetrics
- GETMetrics
- GETGet Metrics Configuration
- PUTPut Metrics Configuration
- DELDisable configuration
- PUTDerive the configuration
- POSTEnable configuration
- GETFind files
- POSTIssue file download url
- PUTUpdate the materialized view refresh configuration
- POSTCreate a refresh schedule for an existing materialized view
- DELArchive the materialized view refresh configuration
- POSTRun a materialized view refresh now
Subscriptions
- GETGet subscriptions
- POSTCreate a subscription
- GETGet cost forecasts
- POSTCreate a cost forecast
- GETGet a cost forecast
- POSTGet matches
- GETGet a subscription
- PUTUpdate a subscription
- DELDelete a subscription
- POSTActivate a subscription
- POSTCancel a subscription
- POSTCheckout a subscription
- GETGet subscription cost forecasts
- POSTCreate a cost forecast for a subscription
- GETGet deliveries
- POSTGet a delivered file
- GETGet subscription matches
- GETGet schema
Data Shops
Data Streams
- POSTCreate a data-stream.
- GETGet a data-stream by its id.
- PUTUpdate a data-stream.
- POSTFetch many data-streams
- GETGet all data-streams for a company.
- GETGet all data-streams for a company given a search expression.
- GETGets the data-stream for a given company and slug.
- GETGet schema
- GETGet all data-streams for the given company and its data-shop hostname.
- GETFind data-streams for the given company and its data-shop hostname and the given search expression.
- GETGet all data-streams for a company given a sales channel
- GETFind data-streams for the given company and a sales-channel and the given search expression.
- GETFind data-streams available on the data-streams-market.
Encryption Materials
Schema Inference
Installations
Profiles
Company
Company Marketing Information
Mappings
Model Inference
Payment Methods
Schema Presets
Uploads
Destinations
Products
Permissions
Contracts
Whoami
Webhooks
Get a company
Copy
curl --request GET \
--url https://api-dev.narrative.io/company/{company_id} \
--header 'Authorization: Bearer <token>'Copy
{
"company_id": 42,
"name": "ACM",
"slug": "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]",
"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,
"created_at": "2016-06-09T02:00:47Z",
"created_by": "[email protected]",
"last_updated_at": "2023-08-17T16:18:10.386058Z",
"last_updated_by": "[email protected]"
}Company
Get a company
GET
/
company
/
{company_id}
Get a company
Copy
curl --request GET \
--url https://api-dev.narrative.io/company/{company_id} \
--header 'Authorization: Bearer <token>'Copy
{
"company_id": 42,
"name": "ACM",
"slug": "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]",
"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,
"created_at": "2016-06-09T02:00:47Z",
"created_by": "[email protected]",
"last_updated_at": "2023-08-17T16:18:10.386058Z",
"last_updated_by": "[email protected]"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The id of an existing company
Response
200 - application/json
OK
Unique identifier of an existing company.
Example:
7
Name of the company
Unique id for the company
A short description of the company
The complete description of the company
The url of the logo of the company
The geographical location of the company
The number of employees
The url of the website of the company
Email contact
Twitter account
LinkedIn account
The instant this company was created.
Example:
"2021-06-24T00:54:40.029056Z"
Contact of user who created the company
The instant this company was created.
Example:
"2021-06-24T00:54:40.029056Z"
Contact of user who updated the company
Available options:
invisible, visible, invisible_in_discover Available options:
active, deleted, pending ⌘I