Searches the number marketplace and browses held numbers and account resources. Purchases, payments, deletions and API token management are never performed by a query operation.
What you can do (59)
What you can do
Available commands: 59 (59 read, 0 write). Enable only the commands your application needs.
| Command | Effect |
|---|---|
Search available numbers — numberbarn.search |
Read |
Browse held numbers — numberbarn.numbers |
Read |
Read number details — numberbarn.number |
Read |
Browse contacts — numberbarn.findContacts |
Read |
Browse categories — numberbarn.findCategories |
Read |
Browse countries — numberbarn.findCountries |
Read |
Browse regions — numberbarn.findStates |
Read |
Browse area codes — numberbarn.findNpas |
Read |
Browse quotes — numberbarn.findOffers |
Read |
Browse saved searches — numberbarn.findSavedSearches |
Read |
Browse greetings — numberbarn.findGreetings |
Read |
Browse voicemail — numberbarn.findVoicemails |
Read |
Browse broker tasks — numberbarn.findBrokerageJobs |
Read |
Browse listings — numberbarn.findBrokerageListings |
Read |
Browse number permissions — numberbarn.findBrokerageLicenses |
Read |
Browse negotiations — numberbarn.findBrokerageNegotiations |
Read |
Browse payments — numberbarn.findBrokeragePayouts |
Read |
Browse transactions — numberbarn.findBrokerageTransactions |
Read |
Browse local access and transport areas — numberbarn.findLatas |
Read |
Browse area-code and exchange prefixes — numberbarn.findNpaNxxs |
Read |
Browse area-code, exchange and block prefixes — numberbarn.findNpaNxxXs |
Read |
Browse number patterns — numberbarn.findNumberPatterns |
Read |
Browse operating company numbers — numberbarn.findOcns |
Read |
Browse postal codes — numberbarn.findPostalCodes |
Read |
Browse rate centers — numberbarn.findRateCenters |
Read |
Browse secondary-market toll-free numbers — numberbarn.findSecondaryMarketTfns |
Read |
Browse number spellings — numberbarn.findNumberSpellings |
Read |
Rank available numbers — numberbarn.findRankedAvailableNumbers |
Read |
Search and rank marketplace numbers — numberbarn.searchMarketplaceNumbers |
Read |
Read caller ID name — numberbarn.getCallerIdName |
Read |
Read carrier and routing details — numberbarn.getNumberInfo |
Read |
Read SMS activation status — numberbarn.getSmsActivation |
Read |
Check available phone-service capabilities — numberbarn.probeAccountAccess |
Read |
Validate a number before purchase — numberbarn.validateNumberPurchase |
Read |
Read an available number — numberbarn.getAvailableNumber |
Read |
Read a brokerage job — numberbarn.getBrokerageJob |
Read |
Read a brokerage job report — numberbarn.getBrokerageJobReport |
Read |
Read a number license — numberbarn.getBrokerageLicense |
Read |
Read a number listing — numberbarn.getBrokerageListing |
Read |
Read a negotiation — numberbarn.getBrokerageNegotiation |
Read |
Read a payout — numberbarn.getBrokeragePayout |
Read |
Read a brokerage transaction — numberbarn.getBrokerageTransaction |
Read |
Read a category — numberbarn.getCategory |
Read |
Read a phone-service contact — numberbarn.getContact |
Read |
Read a country — numberbarn.getCountry |
Read |
Read a greeting — numberbarn.getGreeting |
Read |
Read a local access and transport area — numberbarn.getLata |
Read |
Read an area code — numberbarn.getNpa |
Read |
Read an area-code and exchange prefix — numberbarn.getNpaNxx |
Read |
Read an area-code, exchange and block prefix — numberbarn.getNpaNxxX |
Read |
Read a number pattern — numberbarn.getNumberPattern |
Read |
Read an operating company number — numberbarn.getOcn |
Read |
Read an offer — numberbarn.getOffer |
Read |
Read a postal code — numberbarn.getPostalCode |
Read |
Read a rate center — numberbarn.getRateCenter |
Read |
Read a saved search — numberbarn.getSavedSearch |
Read |
Read a secondary-market toll-free number — numberbarn.getSecondaryMarketTfn |
Read |
Read a region — numberbarn.getState |
Read |
Read a voicemail record — numberbarn.getVoicemail |
Read |
Connect and use
Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.
Get your provider credentials
Follow these steps for NumberBarn, then enter the issued values in the connection form below.
- Request developer/API access from NumberBarn and obtain the account API token. Enter API token and enable approved commands. Capability discovery can report unavailable products; holding a token does not enable every feature.
Where to enter credentials
In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.
| Connection field | Requirement |
|---|---|
| NumberBarn API Token | Required |
Open API keys and create a Tooluse.net key for the enabled commands.
Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.
Configure Claude Code, Codex or Cursor once
Permissions and results
If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.
Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.
Call from your client
Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.
Configure Claude Code, Codex or Cursor once
Discover your enabled tools
List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.
curl 'https://api.tooluse.net/v1/tools' \
-H "Authorization: Bearer $TOOLUSE_API_KEY"
Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.
HTTP call
curl 'https://api.tooluse.net/v1/tool-calls' \
-H "Authorization: Bearer $TOOLUSE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: replace-with-a-new-call-id' \
--data '{
"type": "tool_use",
"id": "toolu_example",
"name": "svc_FROM_YOUR_TOOL_LIST",
"input": {
"search": "415",
"limit": 10
}
}'
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Commands
Search available numbers — numberbarn.search
Run Search available numbers with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
search |
string | Required | Search criteria | minLength: 1; maxLength: 2000 |
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
near |
string | Optional | Location to search near | minLength: 1; maxLength: 200 |
distanceMiles |
integer | Optional | Maximum distance in miles | minimum: 0; maximum: 5000 |
type |
string | Optional | Number type | enum: ["local","tollFree","global"] |
state |
string | Optional | Region code | minLength: 1; maxLength: 10 |
city |
string | Optional | City | minLength: 1; maxLength: 200 |
country |
string | Optional | Country code | minLength: 1; maxLength: 10 |
npa |
string | Optional | Area code | minLength: 1; maxLength: 2000; pattern: "^[0-9]{3}$" |
rateCenter |
string | Optional | Rate center | minLength: 1; maxLength: 200 |
pattern |
string | Optional | Number pattern | minLength: 1; maxLength: 2000 |
maxPriceCents |
integer | Optional | Maximum price in cents | minimum: 0; maximum: 100000000 |
isForSale |
boolean | Optional | Only numbers for sale | |
isForLicense |
boolean | Optional | Only numbers available to license | |
isInstantPortOut |
boolean | Optional | Only instant port-out numbers | |
isNegotiable |
boolean | Optional | Only negotiable numbers | |
isOnSale |
boolean | Optional | Only discounted numbers |
Full JSON Schema
Example input
{
"search": "415",
"limit": 10
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse held numbers — numberbarn.numbers
Run Browse held numbers with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read number details — numberbarn.number
Run Read number details with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
Full JSON Schema
Example input
{
"tn": "14155550123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse contacts — numberbarn.findContacts
Run Browse contacts with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse categories — numberbarn.findCategories
Run Browse categories with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse countries — numberbarn.findCountries
Run Browse countries with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse regions — numberbarn.findStates
Run Browse regions with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse area codes — numberbarn.findNpas
Run Browse area codes with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse quotes — numberbarn.findOffers
Run Browse quotes with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse saved searches — numberbarn.findSavedSearches
Run Browse saved searches with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse greetings — numberbarn.findGreetings
Run Browse greetings with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse voicemail — numberbarn.findVoicemails
Run Browse voicemail with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse broker tasks — numberbarn.findBrokerageJobs
Run Browse broker tasks with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse listings — numberbarn.findBrokerageListings
Run Browse listings with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse number permissions — numberbarn.findBrokerageLicenses
Run Browse number permissions with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse negotiations — numberbarn.findBrokerageNegotiations
Run Browse negotiations with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse payments — numberbarn.findBrokeragePayouts
Run Browse payments with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse transactions — numberbarn.findBrokerageTransactions
Run Browse transactions with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse local access and transport areas — numberbarn.findLatas
Run Browse local access and transport areas with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse area-code and exchange prefixes — numberbarn.findNpaNxxs
Run Browse area-code and exchange prefixes with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse area-code, exchange and block prefixes — numberbarn.findNpaNxxXs
Run Browse area-code, exchange and block prefixes with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse number patterns — numberbarn.findNumberPatterns
Run Browse number patterns with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse operating company numbers — numberbarn.findOcns
Run Browse operating company numbers with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse postal codes — numberbarn.findPostalCodes
Run Browse postal codes with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse rate centers — numberbarn.findRateCenters
Run Browse rate centers with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse secondary-market toll-free numbers — numberbarn.findSecondaryMarketTfns
Run Browse secondary-market toll-free numbers with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Browse number spellings — numberbarn.findNumberSpellings
Run Browse number spellings with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
limit |
integer | Optional | Items per page | minimum: 1; maximum: 50 |
skip |
integer | Optional | Skip count | minimum: 0; maximum: 10000 |
Full JSON Schema
Example input
{
"tn": "14155550123",
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Rank available numbers — numberbarn.findRankedAvailableNumbers
Run Rank available numbers with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
search |
string | Optional | Search criteria | minLength: 1; maxLength: 2000 |
maxPriceCents |
integer | Optional | Maximum price in cents | minimum: 0; maximum: 100000000 |
preferredNpas |
array | Optional | Preferred area codes | minItems: 1; maxItems: 5; uniqueItems: true |
preferredNpas[] |
string | Optional | Area code | minLength: 1; maxLength: 2000; pattern: "^[0-9]{3}$" |
preferredStates |
array | Optional | Preferred regions | minItems: 1; maxItems: 10; uniqueItems: true |
preferredStates[] |
string | Optional | Region code | minLength: 1; maxLength: 2000; pattern: "^[A-Za-z]{2}$" |
vanityTerms |
array | Optional | Preferred words | minItems: 1; maxItems: 10; uniqueItems: true |
vanityTerms[] |
string | Optional | Word | minLength: 1; maxLength: 50 |
requireInstantPortOut |
boolean | Optional | Require instant port-out | |
limit |
integer | Optional | Candidates to inspect | minimum: 1; maximum: 50 |
Full JSON Schema
Example input
{
"search": "415",
"limit": 20
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search and rank marketplace numbers — numberbarn.searchMarketplaceNumbers
Run Search and rank marketplace numbers with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
areaCode |
string | Optional | Area code | minLength: 1; maxLength: 2000; pattern: "^[0-9]{3}$" |
budget |
string | Optional | Budget label | minLength: 1; maxLength: 100 |
market |
string | Optional | Market label | minLength: 1; maxLength: 100 |
phrase |
string | Optional | Vanity phrase | minLength: 1; maxLength: 100 |
maxPriceCents |
integer | Optional | Maximum price in cents | minimum: 0; maximum: 100000000 |
preferredNpas |
array | Optional | Preferred area codes | minItems: 1; maxItems: 5; uniqueItems: true |
preferredNpas[] |
string | Optional | Area code | minLength: 1; maxLength: 2000; pattern: "^[0-9]{3}$" |
preferredStates |
array | Optional | Preferred regions | minItems: 1; maxItems: 10; uniqueItems: true |
preferredStates[] |
string | Optional | Region code | minLength: 1; maxLength: 2000; pattern: "^[A-Za-z]{2}$" |
requireInstantPortOut |
boolean | Optional | Require instant port-out | |
limit |
integer | Optional | Results | minimum: 1; maximum: 50 |
Full JSON Schema
Example input
{
"areaCode": "415",
"maxPriceCents": 50000,
"limit": 10
}
At most 5 provider requests per invocation; timeout: 30 seconds.
Read caller ID name — numberbarn.getCallerIdName
Run Read caller ID name with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Owned phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
callerNameTn |
string | Required | Caller phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
Full JSON Schema
Example input
{
"tn": "14155550123",
"callerNameTn": "14155550124"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read carrier and routing details — numberbarn.getNumberInfo
Run Read carrier and routing details with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
realTime |
boolean | Optional | Request real-time lookup |
Full JSON Schema
Example input
{
"tn": "14155550123",
"realTime": false
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read SMS activation status — numberbarn.getSmsActivation
Run Read SMS activation status with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Owned phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
smsTn |
string | Required | SMS phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
Full JSON Schema
Example input
{
"tn": "14155550123",
"smsTn": "14155550124"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Check available phone-service capabilities — numberbarn.probeAccountAccess
Run Check available phone-service capabilities with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 14 provider requests per invocation; timeout: 30 seconds.
Validate a number before purchase — numberbarn.validateNumberPurchase
Run Validate a number before purchase with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
expectedPriceCents |
integer | Optional | Expected price in cents | minimum: 0; maximum: 100000000 |
requireForSale |
boolean | Optional | Require the number to be for sale | |
requireInstantPortOut |
boolean | Optional | Require instant port-out |
Full JSON Schema
Example input
{
"tn": "14155550123",
"requireForSale": true
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read an available number — numberbarn.getAvailableNumber
Run Read an available number with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
Full JSON Schema
Example input
{
"tn": "14155550123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a brokerage job — numberbarn.getBrokerageJob
Run Read a brokerage job with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
brokerageJobId |
string | Required | Brokerage job ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"brokerageJobId": "job-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a brokerage job report — numberbarn.getBrokerageJobReport
Run Read a brokerage job report with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
brokerageChangeJobId |
string | Required | Brokerage change job ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"brokerageChangeJobId": "job-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a number license — numberbarn.getBrokerageLicense
Run Read a number license with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
Full JSON Schema
Example input
{
"tn": "14155550123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a number listing — numberbarn.getBrokerageListing
Run Read a number listing with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
Full JSON Schema
Example input
{
"tn": "14155550123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a negotiation — numberbarn.getBrokerageNegotiation
Run Read a negotiation with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
uuid |
string | Required | Negotiation ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"uuid": "negotiation-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a payout — numberbarn.getBrokeragePayout
Run Read a payout with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
payoutId |
string | Required | Payout ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"payoutId": "payout-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a brokerage transaction — numberbarn.getBrokerageTransaction
Run Read a brokerage transaction with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
brokerageTransactionId |
string | Required | Transaction ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"brokerageTransactionId": "transaction-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a category — numberbarn.getCategory
Run Read a category with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
categoryId |
string | Required | Category ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"categoryId": "category-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a phone-service contact — numberbarn.getContact
Run Read a phone-service contact with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
contactId |
string | Required | Contact ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"contactId": "contact-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a country — numberbarn.getCountry
Run Read a country with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
country |
string | Required | Country code | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"country": "US"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a greeting — numberbarn.getGreeting
Run Read a greeting with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
greetingId |
string | Required | Greeting ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"greetingId": "greeting-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a local access and transport area — numberbarn.getLata
Run Read a local access and transport area with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
lata |
string | Required | LATA code | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"lata": "722"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read an area code — numberbarn.getNpa
Run Read an area code with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
npa |
string | Required | Area code | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"npa": "415"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read an area-code and exchange prefix — numberbarn.getNpaNxx
Run Read an area-code and exchange prefix with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
npaNxx |
string | Required | NPA-NXX prefix | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"npaNxx": "415555"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read an area-code, exchange and block prefix — numberbarn.getNpaNxxX
Run Read an area-code, exchange and block prefix with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
npaNxxX |
string | Required | NPA-NXX-X prefix | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"npaNxxX": "4155551"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a number pattern — numberbarn.getNumberPattern
Run Read a number pattern with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
pattern |
string | Required | Number pattern | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"pattern": "415***1234"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read an operating company number — numberbarn.getOcn
Run Read an operating company number with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
ocn |
string | Required | Operating company number | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"ocn": "1234"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read an offer — numberbarn.getOffer
Run Read an offer with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
uuid |
string | Required | Offer ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"uuid": "offer-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a postal code — numberbarn.getPostalCode
Run Read a postal code with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
postalCode |
string | Required | Postal code | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"postalCode": "94105"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a rate center — numberbarn.getRateCenter
Run Read a rate center with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
rateCenterId |
string | Required | Rate center ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"rateCenterId": "SANFRANCISCO"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a saved search — numberbarn.getSavedSearch
Run Read a saved search with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
savedSearchId |
string | Required | Saved search ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"savedSearchId": "search-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a secondary-market toll-free number — numberbarn.getSecondaryMarketTfn
Run Read a secondary-market toll-free number with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
tn |
string | Required | Phone number | minLength: 1; maxLength: 2000; pattern: "^\\+?[0-9]{10,15}$" |
Full JSON Schema
Example input
{
"tn": "18005550123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a region — numberbarn.getState
Run Read a region with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
state |
string | Required | Region code | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"state": "CA"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Read a voicemail record — numberbarn.getVoicemail
Run Read a voicemail record with NumberBarn. This is a read command; it does not grant access beyond the connected account's permissions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
voicemailId |
string | Required | Voicemail ID | minLength: 1; maxLength: 2000 |
Full JSON Schema
Example input
{
"voicemailId": "voicemail-123"
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Errors
Check the key's expiry, revocation, workspace and allowed operations.
Reuse the same idempotency key only for the same request.
The connection or provider limit has been reached. Check the receipt before retrying.
Test the connection
Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.