Collections

Try every endpoint in your API client

Collections for Postman, Bruno and Hoppscotch, with every CompanyStack request grouped as in the API reference, example inputs filled in, and an environment that holds your API key. They are generated from the OpenAPI spec, so they stay in step with the API.

You need an API key (it starts with cs_). Create one free. Search and company profiles work on the Free plan; other requests return an upgrade message until your plan includes them.

Download

Postman

In Postman choose Import and drop both files in. Pick the “CompanyStack” environment and paste your key into apiKey.

Bruno

Unzip it, then in Bruno choose Open Collection and select the CompanyStack folder. Choose the “CompanyStack” environment and set apiKey (it is kept as a secret). Bruno can also import the Postman file above.

Hoppscotch

In Collections choose Import → Import from Hoppscotch, and in Environments import the environment file, then set apiKey. Hoppscotch also imports the Postman file and the OpenAPI spec.

Insomnia and others

Most API tools import an OpenAPI spec directly. Authenticate with an X-Api-Key header, or Authorization: Bearer, carrying your key.

How the key is sent

The collections send your key as an X-Api-Key header on every request, from the apiKey environment variable. The public endpoints (the sample gallery and calendar feeds) send none. baseUrl is https://api.companystack.co.uk.

Every request counts against your plan's limits. Watch the X-RateLimit-Remaining header; over a limit you get a 429 with Retry-After.

Run from the command line

Newman runs the Postman collection in CI. Run one folder at a time, so you do not spend your quota on every endpoint.

newman 
npx newman run CompanyStack.postman_collection.json \
  -e CompanyStack.postman_environment.json \
  --env-var apiKey=cs_your_key \
  --folder Companies

Writing code instead? See the JavaScript and Python examples. Working with an SI assistant? Connect it to the hosted MCP server.