Every endpoint is published as a Postman collection, generated from the same definitions the API runs on. Nothing in it is hand-maintained, so a new endpoint appears in the collection when it ships.
Open the APIVerve workspace on Postman
Fork it into your own workspace — that gives you a copy you can edit and keeps a link back for updates.
Setting it up
One variable and you are calling live endpoints.
apiverve_api_key — set it to your key from the
dashboard. Every request in the collection sends it in
the x-api-key header, so this is the only thing you have to configure.
Set it as a collection variable (or on an environment, if you keep several keys) rather than editing individual requests. Setting it once makes all 367 requests work.
A collection variable with a real key in it is a credential in a file. If you export or share the fork, clear the value first — or point the variable at an environment you do not share. See authentication for where keys should live.
The other variables rarely need changing:
| Variable | |
|---|---|
base_url | https://api.apiverve.com |
api_version | v1 |
use_mock_server | false. Set true to hit the mock server instead of the live API |
mock_server_url | Filled in automatically when mock mode is available |
How it is organised
Folders per category, each named with how many endpoints it holds — the same categories as the catalog, so finding something here is the same exercise as finding it in the dashboard.
A Getting Started folder at the top, which is where to go first: it walks through setting the key and making one call before you go looking for a specific endpoint.
Every request arrives with its parameters filled in from the endpoint's published example, so Send works immediately rather than after you go and read what the endpoint expects.
Mock mode
Setting use_mock_server to true points the collection at a mock server that returns example
responses.
Two reasons that is useful. It costs no credits, so exploring the shape of a hundred responses is free. And it needs no key, so you can hand the collection to someone who has not signed up yet and they can still see what everything returns.
Switch it back to false when you want real data. The response shapes are the same either way, so
code written against mock responses works against live ones.
What to use it for
Exploring. Clicking through a folder is a faster way to understand a category than reading several reference pages, especially when you are not yet sure which endpoint you want.
Testing a call before you write it. Same job as the playground, with the advantage that Postman keeps a history and lets you save the request.
Running a batch. The Collection Runner will run a folder — or the whole collection — end to end. Worth remembering that every request is a real call on real credits unless mock mode is on, so a full-collection run against the live API is 367 credits and some of those endpoints cost more than one.
Monitoring. Postman monitors can run a saved request on a schedule and alert you if it stops
returning 200. A monitor on the one endpoint your product depends on is a cheap early warning —
and each run costs a credit, so pick the interval deliberately.
Generating code. Postman's code generator turns any request into a snippet in your language. The reference pages do the same thing, and each endpoint's page has four languages already written.
Troubleshooting
401 on every request. The apiverve_api_key variable is empty, or set on an environment you
do not have selected. Check the current value shown next to the variable, not the initial one —
Postman keeps both, and an unsaved initial value is a common cause.
403 naming an endpoint. A key restriction, not a Postman
problem.
429. Either the rate limit — likely if you just ran the Collection Runner over a folder — or
the account is out of credits. See rate limits.
Requests missing. Your fork is out of date; re-fork or pull from the source collection. The published one is regenerated from the catalog.
Next
All endpoints is the same catalog with full reference pages, and the SDKs are the next step once a request works and you want it in code.