External API docs

Troubleshooting & FAQ

Find the error message, error number, or result shown in your app, then follow the plain-language steps. Technical details are available for the person who manages your connection.

Find your error or result

Account & access

Problems with API keys, credits, or permission to use an action.

“Invalid API Key”Error 401

What this means

Openmart can't verify your API key

Openmart couldn't recognize the API key connected to your app or workflow. The key may be missing, incomplete, or no longer active.

What you can do

  1. Open API management and confirm that the key is active.
  2. If you recently created a new key, update the app or workflow that connects to Openmart.
  3. Copy the complete error message, but never copy or share the API key itself.
Ask the person who manages your connection
Ask for help if you don't manage the connection yourself, or if the key is active and the error continues.
Show technical details

Send the key in the Authorization: Bearer <your_api_key> request header. Existing integrations may also use X-API-Key. A missing or unknown key returns HTTP 401. You can test the same key with GET /api/v2/credit-balance.

“Credit limit reached”Error 402

What this means

Your team may need more credits

Your team doesn't currently have enough available credits, or your account needs a billing check before the action can finish.

What you can do

  1. Check your team's remaining balance in API management.
  2. Ask your Openmart account owner whether more credits or a billing update are needed.
  3. Run the same action again after the account issue has been resolved.
Ask the person who manages your connection
Ask for help if the balance looks sufficient, only one app is affected, or you need to find which workflow used the credits.
Show technical details

Credit-related failures return HTTP 402. Check the balance with GET /api/v2/credit-balance. Do not automatically retry a 402 response until the account issue is resolved.

“Forbidden” or “not allowed”Error 403

What this means

Your key doesn't have access to this action

Openmart recognized the key, but that key or account isn't allowed to use this action or one of its options.

What you can do

  1. Confirm that the app is connected to the correct Openmart account and workspace.
  2. Ask your account owner whether the key or account has access limits.
  3. Copy the exact error message and note which Openmart action you were trying to use.
Ask the person who manages your connection
Ask the person who manages your connection to check the API key and account access.
Show technical details

HTTP 403 means the key was recognized, but the account or key cannot use the requested action or option. Do not retry until access or request options have changed.

Requests & results

Problems with information you send or the records that come back.

“Country is required” or another field errorError 400 / 422

What this means

Some information is missing or invalid

Some information is missing, entered in the wrong format, or outside the limit allowed for that action.

What you can do

  1. Copy the complete error message—it often names the information that needs attention.
  2. If you recently changed a field, filter, or batch size, undo that change and try again.
  3. Double-check required information such as country, business ID, or website.
Ask the person who manages your connection
Ask for help if the message mentions JSON, validation, UUID, cursor, or request body, or if another tool creates the action automatically.
Show technical details

HTTP 400 and 422 are not temporary failures. Check the response's error or detail field. Common messages include:

  • “Limit maximum value is 50”
  • “Country is required”
  • “the number of tasks in each batch should be between 1 and 100”
  • “Type must be one of [email phone]”

“Not Found”Error 404

What this means

The API address or request method may be incorrect

The app reached the server, but the API address or action type did not match an available endpoint.

What you can do

  1. Copy the complete API address shown in the failed request.
  2. Compare the address and action type—GET, POST, or DELETE—with the endpoint page.
  3. Check that the address starts with https://api.openmart.ai and uses the documented API version.
Ask the person who manages your connection
Ask the person who manages your connection to compare the request method, path, and API version with the current docs.
Show technical details

HTTP 404 is not retryable until the request URL or method changes. Pay special attention to /api/v1/ versus /api/v2/ and to path parameters such as a batch ID or task ID.

No records returned

What this means

Your search completed without matches

The search worked, but Openmart couldn't find records that match all of the information and filters you provided.

What you can do

  1. Start with a broader search and remove one optional filter at a time.
  2. Double-check spelling in the business name, website, city, state, and country.
  3. Try a simple search that you know should return results, then add filters back one at a time.
Ask the person who manages your connection
Ask for help if the same search works in Openmart but not in your connected app, or if the result format looks different from the docs.
Show technical details

Check whether tags replaced the normal search query, whether location filters are too narrow, and whether the response envelope changed because estimate_total=true.

Only some records returned

What this means

Results may be split across pages or some IDs didn't match

The action worked, but some IDs didn't match a record or the full result set is split across multiple pages.

What you can do

  1. Compare the IDs or businesses you sent with the records that came back.
  2. Look for a “next page,” “load more,” or pagination setting in the app you are using.
  3. Try a smaller group of IDs to see whether the same records are still missing.
Ask the person who manages your connection
Ask for help if records disappear only after the first page, or if you need to confirm how the connected app handles missing IDs and pagination.
Show technical details

Business-record endpoints silently omit IDs with no matching record. Search endpoints return a limited page and a cursor for the next page. Reuse the complete cursor from the previous response without editing it.

Processing & availability

Problems with long-running jobs, request volume, or temporary outages.

Job still processingStatus: PROCESSING

What this means

Your background job isn't finished yet

Some Openmart enrichment jobs run in the background. A successful start means the work began, not that the final result is ready.

What you can do

  1. Save the job ID shown when the action starts. The API calls this a batch ID.
  2. Give the job a few minutes and check its status before starting it again.
  3. Avoid submitting the same job again while the original one is still processing.
Ask the person who manages your connection
Ask for help if no job ID was saved, the job shows ERRORED or CANCELLED, or it stays in the same state for an unusually long time.
Show technical details

Poll GET /api/v1/task/batch/:batch_id/status until batch_ready is true. Then retrieve task IDs and final results. Set the HTTP client timeout to at least 60 seconds for batch-submission requests.

“Too many requests”Error 429

What this means

Your app is sending actions too quickly

Your app or workflow is asking Openmart to do too much at the same time.

What you can do

  1. Wait a short time before running the same action again.
  2. Reduce the number of actions running at the same time.
  3. If the workflow runs on a schedule, spread the work over a longer period.
Ask the person who manages your connection
Ask the person who manages your connection to reduce concurrency and make sure automatic retries are not creating more traffic.
Show technical details

HTTP 429 is retryable. Honor the Retry-After header when present and use increasing delays between attempts.

Timeout or server errorErrors 500–504

What this means

Openmart or the connection may be temporarily unavailable

A temporary Openmart, network, or connected-app problem interrupted the action.

What you can do

  1. Wait a short time, then try the action once more.
  2. Check whether other websites and connected apps are working normally.
  3. Record the time and copy the complete error message if the problem continues.
Ask the person who manages your connection
Ask for help if the problem continues after several minutes, only one network or app is affected, or retries keep failing.
Show technical details

Retry HTTP 5xx responses and network errors with increasing delays. If an async submission timed out, the batch may still have been created; check for its batch ID before submitting a duplicate job.

Frequently asked questions

Where can I find or replace my API key?

Sign in to Openmart and open API management. If another person manages your connection, ask them to update the key in the app or workflow for you.

Is it safe to send my API key to support?

No. Never send an API key in email, chat, screenshots, or support requests. Send the exact error message and remove sensitive information from any examples.

Why does it work in one tool but not another?

Different apps can send the same action in different ways. Tell the person who manages your connection which tool works, which tool fails, and the exact error shown. Some clients or proxies may drop a body from a GET request. Never put an Openmart API key directly in public browser code.

My job timed out. Could it still be running?

Yes. A background job may have started even if your app stopped waiting for the response. Look for the job ID or batch ID and check its status before starting the same job again.

Why are some fields blank, null, or missing?

Openmart may not have every field for every business. Your app should treat a missing value, null, and an empty list as “no value available” unless the endpoint page says otherwise.

Why does the response sometimes look different?

Some endpoints return a simple list by default but wrap the list with a total count when estimate_total=true. Compare your setting with the response examples on that endpoint's page.

Which errors should be tried again?

Error 429, temporary server errors such as 500–504, and network timeouts can usually be tried again after waiting. API key, credit, access, and invalid-information errors must be fixed first.

Why did I receive a batch ID instead of results?

Some enrichment jobs run in the background. The batch ID is the job ID your app uses to check progress and collect the final results.

Still need help?

Send the information below to your Openmart contact or the person who manages your connection. This helps them investigate without needing your API key.

What you were trying to do
The app or workflow you were using
The exact error message or a screenshot
The time it happened and your time zone
The error number, if one was shown
The support reference number, if one was shown
Technical information to include, if available
  • Request method and endpoint
  • HTTP status and complete response body
  • Request ID
  • A request example with API keys and personal data removed