NumberBarn API

https://www.numberbarn.com/api/docs/
Admin
NumberBarn API is a REST API for managing telephone numbers, enabling users to purchase, port, and...
Tokens:121,035
Snippets:730
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### HTTP Client Request Example

Source: https://www.numberbarn.com/api/docs/api/find-secondary-market-tfns

This example demonstrates how to make a GET request to the secondary market TFNS API using HttpClient in C#. Ensure the response is successful before reading the content.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/secondaryMarketTfns");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Offers API Response Example

Source: https://www.numberbarn.com/api/docs/api/get-offers

This is an example of a successful response when retrieving offers. It includes details such as offer UUID, telephone number, dates, pricing, and status.

```json
{
  "uuid": "12345678-abcd-abcd-abcd-12345678abcd",
  "tn": "18005550000",
  "formattedTn": "(858) 555-1212",
  "createDate": "2025-03-06T09:21:00.000Z",
  "expirationDate": "2025-03-06T09:21:00.000Z",
  "offer": 7500,
  "originalPrice": 7500,
  "counterOffer": 7500,
  "initialOffer": 7500,
  "status": "submitted",
  "loginToken": "XXXXYY"
}
```

--------------------------------

### C# HttpClient Example

Source: https://www.numberbarn.com/api/docs/api/get-activate-sms

Demonstrates how to make a GET request to the NumberBarn API using C# HttpClient. Ensure you replace `<token>` with your actual authorization token.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

```

--------------------------------

### Making a GET Request to /api/offers/:uuid in C#

Source: https://www.numberbarn.com/api/docs/api/get-offers

Example of how to make an HTTP GET request to retrieve offers using HttpClient in C#. Ensure the Accept header is set to application/json.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/offers/:uuid");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient API Request Example

Source: https://www.numberbarn.com/api/docs/api/find-spellings

Example of making a GET request to the NumberBarn API using C#'s HttpClient. Ensure the Accept header is set to application/json.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get List Licenses

Source: https://www.numberbarn.com/api/docs/api/get-list-licenses

Retrieves a list of licenses. The response includes details such as the telephone number, its formatted version, license status, start and end dates, setup fee, monthly fee, and annual increase percentage.

```APIDOC
## Get List Licenses

### Description
Retrieves a list of licenses. The response includes details such as the telephone number, its formatted version, license status, start and end dates, setup fee, monthly fee, and annual increase percentage.

### Method
GET

### Endpoint
/licenses

### Response
#### Success Response (200)
- **tn** (string) - Telephone number
- **formattedTn** (string) - Formatted telephone number
- **status** (string) - The status of the license. Possible values: [`pending`, `active`, `completed`]
- **startDate** (Date) - The start date for licensing the phone number
- **endDate** (Date) - The end date for licensing the phone number
- **oneTimeSetupFee** (number) - The one-time setup fee for licensing the phone number (in USD cents)
- **monthlyFee** (number) - The monthly fee for licensing the phone number (in USD cents)
- **annualIncrease** (number) - The annual percent increase for licensing the phone number

#### Response Example
```json
{
  "tn": "18005550000",
  "formattedTn": "(858) 555-1212",
  "status": "active",
  "startDate": "2025-03-24T18:28:29.362Z",
  "endDate": "2025-03-24T18:28:29.362Z",
  "oneTimeSetupFee": 2500,
  "monthlyFee": 995,
  "annualIncrease": 4
}
```
```

--------------------------------

### Get Brokerage Listings Success Response

Source: https://www.numberbarn.com/api/docs/api/get-brokerage-listings

Example of a successful response when retrieving brokerage listings. Includes all possible fields for a listing.

```json
{
  "tn": "18005550000",
  "formattedTn": "(858) 555-1212",
  "type": "'onnet' or 'offnet'",
  "npa": 212,
  "isTollFree": "true",
  "isListed": "true",
  "price": 10000,
  "isLicensable": "true",
  "licenseOneTimeFee": 10000,
  "licenseMonthlyFee": 4900,
  "licenseAnnualIncrease": "5",
  "isNegotiable": "true",
  "minimumOffer": 10000,
  "isPigPick": "true",
  "pigPickPercentage": "25",
  "spelling": "BARN",
  "spid": "NumberBarn",
  "isOnSale": true,
  "needsVerification": true,
  "activeNegotiationExpirationDate": "2025-03-24T18:28:29.362Z",
  "somosSecondaryMarket": "true",
  "createDate": "2025-03-24T18:28:29.362Z",
  "deleteDate": "2025-03-24T18:28:29.362Z",
  "sellDate": "2025-03-24T18:28:29.362Z",
  "verifiedUntilDate": "2025-03-24T18:28:29.362Z",
  "isVerified": true,
  "bundleId": "bun_xxxxxxxx",
  "satisfiesPattern": "XYXY"
}
```

--------------------------------

### C# Example: Fetching Secondary Market TFNS

Source: https://www.numberbarn.com/api/docs/api/get-secondary-market-tfns

This C# code demonstrates how to make a GET request to the secondaryMarketTfns endpoint. Ensure you replace ':tn' with the actual Toll-Free Number you are querying.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/secondaryMarketTfns/:tn");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Example for API Request

Source: https://www.numberbarn.com/api/docs/api/get-npas

This C# code demonstrates how to make a GET request to the API using HttpClient. Ensure the Accept header is set to application/json.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/npas/:npa");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Postal Code C# Example

Source: https://www.numberbarn.com/api/docs/api/get-postal-codes

This C# example demonstrates how to make an HTTP GET request to the postal codes API using HttpClient. Ensure the response is successful before reading the content.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/postalCodes/:postalCode");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Example

Source: https://www.numberbarn.com/api/docs/api/find-npa-nxxs

This C# code snippet demonstrates how to make a GET request to the Find NPA/NXXs API using HttpClient. Ensure the request includes the 'Accept: application/json' header.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/npaNxxs");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Making a GET Request with Authorization in C#

Source: https://www.numberbarn.com/api/docs/api/get-caller-name

Demonstrates how to make a GET request to the API using HttpClient in C#. Ensure you replace `<token>` with your actual Bearer token.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Example with Bearer Token

Source: https://www.numberbarn.com/api/docs/api/create-activate-sms

Demonstrates how to make a GET request to the NumberBarn API using HttpClient in C#, including setting the Authorization header with a Bearer token and Accept header.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Get Rate Centers API Response Example

Source: https://www.numberbarn.com/api/docs/api/get-rate-centers

This is an example of a successful response when retrieving rate center information. It includes details like rate center ID, name, city, state, and geographical coordinates.

```json
{
  "rateCenterId": "ABCDEF123456",
  "rateCenter": "DENVER",
  "fullName": "string",
  "city": "San Diego",
  "state": "CA",
  "country": "US",
  "lata": "string",
  "vCoordinate": 0,
  "hCoordinate": 0,
  "latitude": -117.1297,
  "longitude": 33,
  "poolingStatus": "string"
}
```

--------------------------------

### Get Brokerage Listings (C#)

Source: https://www.numberbarn.com/api/docs/api/get-brokerage-listings

Use HttpClient to make a GET request to the brokerage listings endpoint. Ensure to set the Accept and Authorization headers.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/brokerage/listings/:tn");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Get Negotiation Success Response

Source: https://www.numberbarn.com/api/docs/api/get-negotiation

This example shows the structure of a successful response when retrieving negotiation details. It includes identifiers, status, dates, and offer information.

```json
{
  "uuid": "12345678-abcd-abcd-abcd-12345678abcd",
  "tn": "18005550000",
  "formattedTn": "(858) 555-1212",
  "status": "accepted",
  "createDate": "2025-03-24T18:28:29.362Z",
  "expirationDate": "2025-03-24T18:28:29.362Z",
  "offer": 7500,
  "declinedReason": "minimumOffer",
  "initialOffer": 0,
  "minimumOffer": 0,
  "originalPrice": 0,
  "counterOffer": 0,
  "spelling": "string"
}
```

--------------------------------

### Get Countries API Request (C# HttpClient)

Source: https://www.numberbarn.com/api/docs/api/get-countries

Example of how to make a GET request to the /api/countries/:country endpoint using C# HttpClient. Ensure the request includes an 'Accept: application/json' header.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/countries/:country");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Create Contact Request Example

Source: https://www.numberbarn.com/api/docs/api/create-contacts

This is an example of a JSON payload for creating a new contact. Ensure all required fields like contactId, tn, and name are included.

```json
{
  "contactId": "ABCDEF123456",
  "tn": "18005550000",
  "name": "John Doe",
  "isBlocked": true,
  "createDate": "2025-03-06T09:21:00.000Z"
}
```

--------------------------------

### Get Brokerage Transaction C# Example

Source: https://www.numberbarn.com/api/docs/api/get-brokerage-transaction

This C# code snippet demonstrates how to make a GET request to retrieve a brokerage transaction. Ensure you replace `<token>` with your actual Bearer token and `:brokerageTransactionId` with the transaction's ID. The response is printed to the console.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/brokerage/transactions/:brokerageTransactionId");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### C# HttpClient Example

Source: https://www.numberbarn.com/api/docs/api/get-telephone-number-info

This C# code demonstrates how to make a GET request to the numberInfo endpoint using HttpClient. Ensure the Accept header is set to application/json for a JSON response. The EnsureSuccessStatusCode method will throw an exception if the response is not a success code.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/numberInfo/:tn");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient API Request Example

Source: https://www.numberbarn.com/api/docs/api/get-available-telephone-numbers

This C# code snippet demonstrates how to make a GET request to the NumberBarn API using HttpClient. Ensure the 'Accept' header is set to 'application/json'.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/availableNumbers/:tn");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get NPAs Success Response Example

Source: https://www.numberbarn.com/api/docs/api/get-npas

This example shows the structure of a successful response when retrieving NPA information. It includes details like area code, population, largest city, state, country, geographic coordinates, and support status.

```json
{
  "npa": "619",
  "population": 12345,
  "largestCity": "New York",
  "largestCounty": "Los Angeles",
  "state": "CA",
  "country": "US",
  "lat": -117.1297,
  "lon": 33,
  "overlapping": "Unknown Type: string[]",
  "adjacent": "Unknown Type: string[]",
  "cities": "Unknown Type: string[]",
  "starbucks": 400,
  "isSupported": true,
  "isExhausted": true,
  "isTollFree": true,
  "isFuture": true
}
```

--------------------------------

### Not Found (404) Error Response Example

Source: https://www.numberbarn.com/api/docs/api/patch-saved-searches

This example demonstrates the JSON format for a NotFound error. It includes the error name, message, and code, which are standard for API error responses.

```json
{
  "name": "name",
  "message": "message",
  "code": 404
}
```

--------------------------------

### API Response Example

Source: https://www.numberbarn.com/api/docs/api/numberbarn-api

Example of a JSON response structure from the NumberBarn API, showing NPA data.

```json
{
    "...": "",
    "data": [
        { "npa": "201", "state": "NJ", "country": "US" },
        { "npa": "202", "state": "DC", "country": "US" },
        ...
    ]
}
```

--------------------------------

### Find NPA-NXX API Response Example

Source: https://www.numberbarn.com/api/docs/api/find-npa-nxxs

This example demonstrates the structure of a successful response when searching for NPA-NXX information. It includes NPA-NXX, NPA, NXX, rate center, state, and country details.

```json
[
  {
    "npaNxx": "619234",
    "npa": "619",
    "nxx": "234",
    "rateCenter": "DENVER",
    "state": "CA",
    "country": "US"
  }
]
```

--------------------------------

### Example API Response for NPAs

Source: https://www.numberbarn.com/api/docs

This is an example of a successful API response when requesting NPAs, showing the structure of the returned data.

```json
{
    "...": "...",
    "data": [
        { "npa": "201", "state": "NJ", "country": "US" },
        { "npa": "202", "state": "DC", "country": "US" },
        ...
    ]
}
```

--------------------------------

### Patch Saved Searches Request Example

Source: https://www.numberbarn.com/api/docs/api/patch-saved-searches

This example shows the structure of a JSON payload to update a saved search. Ensure all required fields are present and correctly formatted.

```json
{
  "savedSearchId": "ABCDEF123456",
  "email": "porky@numberbarn.com",
  "frequency": "once",
  "nickname": "string",
  "search": {
    "type": "local",
    "search": "string",
    "npa": "string",
    "state": "string"
  },
  "lastNotifyDate": "Unknown Type: Date"
}
```

--------------------------------

### Get Brokerage Job Details (C#)

Source: https://www.numberbarn.com/api/docs/api/get-brokerage-job

Use HttpClient to make a GET request to the brokerage jobs endpoint. Ensure you include the 'Authorization' header with your Bearer token and the 'Accept' header for JSON.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/brokerage/jobs/:brokerageJobId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

```

--------------------------------

### Get Negotiation Request in C#

Source: https://www.numberbarn.com/api/docs/api/get-negotiation

This C# code snippet demonstrates how to make a GET request to the /api/brokerage/negotiations/:uuid endpoint using HttpClient. Ensure the response is handled appropriately.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/brokerage/negotiations/:uuid");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Caller Name Example

Source: https://www.numberbarn.com/api/docs/api/get-caller-name

Example of how to make a GET request to the NumberBarn API to get caller name information.

```APIDOC
## GET /api

### Description
Retrieves caller name information from the NumberBarn API.

### Method
GET

### Endpoint
https://www.numberbarn.com/api

### Parameters
#### Query Parameters
- **tn** (string) - Required - The phone number to query.

### Request Example
```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api?tn=1234567890");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

### Response
#### Success Response (200)
- **callerName** (string) - The name associated with the phone number.
- **number** (string) - The phone number queried.

#### Response Example
```json
{
  "callerName": "Example Name",
  "number": "1234567890"
}
```
```

--------------------------------

### C# HttpClient Example

Source: https://www.numberbarn.com/api/docs/api/find-voicemails

Demonstrates how to fetch voicemails using HttpClient in C#. Ensure you replace `<token>` with your actual Bearer token.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/voicemails");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

```

--------------------------------

### Example C# HTTP Client Usage

Source: https://www.numberbarn.com/api/docs/api/create-activate-sms

This snippet demonstrates how to use HttpClient in C# to interact with the API, including setting the authorization token.

```APIDOC
## GET https://www.numberbarn.com/api

### Description
This endpoint is used to retrieve information from the NumberBarn API. It requires an authorization token for access.

### Method
GET

### Endpoint
https://www.numberbarn.com/api

### Headers
- **Accept**: application/json
- **Authorization**: Bearer <token>

### Request Example
```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

### Response
#### Success Response (200)
- **body**: (string) - The response content from the API.
```

--------------------------------

### Get Voicemail

Source: https://www.numberbarn.com/api/docs/api/get-voicemails

This example shows how to retrieve a voicemail using its ID with an HTTP GET request.

```APIDOC
## GET /api/voicemails/:voicemailId

### Description
Retrieves a specific voicemail by its unique identifier.

### Method
GET

### Endpoint
https://www.numberbarn.com/api/voicemails/:voicemailId

### Parameters
#### Path Parameters
- **voicemailId** (string) - Required - The unique identifier of the voicemail to retrieve.

### Request Example
```http
GET /api/voicemails/123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: www.numberbarn.com
Authorization: Bearer <token>
Accept: application/json
```

### Response
#### Success Response (200)
- **voicemailId** (string) - The unique identifier of the voicemail.
- **callerName** (string) - The name of the caller.
- **callerNumber** (string) - The phone number of the caller.
- **timestamp** (string) - The date and time the voicemail was received.
- **duration** (integer) - The duration of the voicemail in seconds.
- **audioUrl** (string) - A URL to the voicemail audio file.

#### Response Example
```json
{
  "voicemailId": "123e4567-e89b-12d3-a456-426614174000",
  "callerName": "John Doe",
  "callerNumber": "+15551234567",
  "timestamp": "2023-10-27T10:00:00Z",
  "duration": 60,
  "audioUrl": "https://example.com/audio/voicemail.mp3"
}
```
```

--------------------------------

### Retrieve Licenses using C# HttpClient

Source: https://www.numberbarn.com/api/docs/api/get-list-licenses

Demonstrates how to make a GET request to the licenses endpoint using C#'s HttpClient. Ensure you replace `<token>` with your actual Bearer token.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/brokerage/licenses/:tn");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Make an API Request

Source: https://www.numberbarn.com/api/docs/api/numberbarn-api

Example of how to make a basic API request using curl to retrieve NPAs.

```bash
curl https://www.numberbarn.com/api/npas  
```

--------------------------------

### Query Parameters Example

Source: https://www.numberbarn.com/api/docs/api/numberbarn-api

Demonstrates how to format query parameters for API requests, including special parameters like $fields, $sort, and $limit.

```APIDOC
## Query Parameters Formatting

### Description
This section illustrates how to format JSON query parameters into a URL query string for HTTP requests.

### Example JSON Parameters
```json
{
  "$fields": ["tn", "npa", "nickname"],
  "$sort": { "tn": "asc" },
  "$limit": 10
}
```

### Corresponding URL Query String
```
https://www.numberbarn.com/api/numbers?$fields[]=tn&$fields[]=npa&$fields[]=nickname&$sort[tn]=asc&$limit=10
```
```

--------------------------------

### Get NPA NXX XS API Request in C#

Source: https://www.numberbarn.com/api/docs/api/get-npa-nxx-xs

Example of how to make a GET request to the NPA NXX XS API using HttpClient in C#. Ensure the Accept header is set to application/json.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/npaNxxXs/:npaNxxX");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get NPAs

Source: https://www.numberbarn.com/api/docs/api/numberbarn-api

This endpoint retrieves a list of NPAs (Numbering Plan Areas) with their associated state and country. It's a basic example of how to interact with the API.

```APIDOC
## GET /npas

### Description
Retrieves a list of NPAs (Numbering Plan Areas) with their associated state and country.

### Method
GET

### Endpoint
https://www.numberbarn.com/api/npas

### Request Example
```
curl https://www.numberbarn.com/api/npas
```

### Response
#### Success Response (200)
- **data** (array) - An array of NPA objects.
  - **npa** (string) - The NPA code.
  - **state** (string) - The state associated with the NPA.
  - **country** (string) - The country associated with the NPA.

#### Response Example
```json
{
    "data": [
        { "npa": "201", "state": "NJ", "country": "US" },
        { "npa": "202", "state": "DC", "country": "US" },
        ...
    ]
}
```
```

--------------------------------

### Fetch Countries using HttpClient in C#

Source: https://www.numberbarn.com/api/docs/api/find-countries

Example of how to fetch a list of countries using HttpClient in C#. Ensure the request includes the 'Accept: application/json' header.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/countries");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Include Parameter Example

Source: https://www.numberbarn.com/api/docs/api/numberbarn-api

Uses the $include operator to request additional related data, such as location information.

```json
{
  $include: ["location"]
}
```

```json
[
  {
    // normal tn fields...
    location: {
        // location fields ...
    }
  },
]
```

--------------------------------

### Get Caller ID Name - Success Response

Source: https://www.numberbarn.com/api/docs/api/get-caller-name

This is an example of a successful response when retrieving a caller ID name. It includes the telephone number, caller ID name, and type of service.

```json
{
  "tn": "18005550000",
  "cnam": "RON BURGUNDY",
  "cnamTos": "business"
}
```

--------------------------------

### Pagination Parameters

Source: https://www.numberbarn.com/api/docs/api/numberbarn-api

Explains how to use $limit and $skip parameters for paginating through result sets.

```APIDOC
## Pagination

### Description
Result sets can be paginated using the `$limit` and `$skip` query parameters.

### Parameters
- **$limit** (integer) - The maximum number of records to return per request. The maximum allowed value may vary per resource.
- **$skip** (integer) - Number of records to skip.
```

--------------------------------

### Update Brokerage Listing

Source: https://www.numberbarn.com/api/docs/api/patch-brokerage-listings

This example demonstrates how to update a brokerage listing using an HTTP PATCH request. It includes setting the listing status, price, licensing details, negotiation parameters, and other relevant information.

```APIDOC
## PATCH /api/brokerage/listings/:tn

### Description
Updates the details of a specific brokerage listing.

### Method
PATCH

### Endpoint
/api/brokerage/listings/:tn

### Parameters
#### Path Parameters
- **tn** (string) - Required - The unique identifier of the listing to update.

#### Request Body
- **isListed** (string) - Optional - Indicates if the listing is currently active. Accepts 'true' or 'false'.
- **price** (number) - Optional - The current price of the listing.
- **isLicensable** (string) - Optional - Indicates if the listing is available for licensing. Accepts 'true' or 'false'.
- **licenseOneTimeFee** (number) - Optional - The one-time fee for licensing.
- **licenseMonthlyFee** (number) - Optional - The monthly fee for licensing.
- **licenseAnnualIncrease** (string) - Optional - The percentage increase for the annual license fee.
- **isNegotiable** (string) - Optional - Indicates if the price is negotiable. Accepts 'true' or 'false'.
- **minimumOffer** (number) - Optional - The minimum acceptable offer for the listing.
- **isPigPick** (string) - Optional - Indicates if the listing is a 'Pig Pick' (special promotion). Accepts 'true' or 'false'.
- **pigPickPercentage** (string) - Optional - The percentage associated with the 'Pig Pick' promotion.
- **spelling** (string) - Optional - A specific spelling associated with the listing (e.g., for branding).
- **bundleId** (string) - Optional - The ID of a bundle associated with this listing.

### Request Example
```json
{
  "isListed": "true",
  "price": 10000,
  "isLicensable": "true",
  "licenseOneTimeFee": 10000,
  "licenseMonthlyFee": 4900,
  "licenseAnnualIncrease": "5",
  "isNegotiable": "true",
  "minimumOffer": 10000,
  "isPigPick": "true",
  "pigPickPercentage": "25",
  "spelling": "BARN",
  "bundleId": "bun_xxxxxxxx"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the listing was updated successfully.

#### Response Example
```json
{
  "message": "Listing updated successfully."
}
```
```

--------------------------------

### Update Greeting C# Example

Source: https://www.numberbarn.com/api/docs/api/patch-greetings

Demonstrates how to update a greeting using HttpClient in C#. Ensure you replace `<token>` with your actual Bearer token and `:greetingId` with the specific greeting's ID.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "https://www.numberbarn.com/api/greetings/:greetingId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

```

--------------------------------

### Currency Formatting

Source: https://www.numberbarn.com/api/docs/api/numberbarn-api

Shows how currency values are represented in cents and their formatted string equivalent.

```json
{
    "price": 999999,
    "formattedPrice": "$9,999.99",
    "reservePrice": 60000,
    "formattedReservePrice": "$600.00",
    ...
}
```

--------------------------------

### Get NPA-NXXs Success Response

Source: https://www.numberbarn.com/api/docs/api/get-npa-nxxs

This is a successful response from the Get NPA-NXXs endpoint, providing details about a specific NPA-NXX code.

```json
{
  "npaNxx": "619234",
  "npa": "619",
  "nxx": "234",
  "rateCenter": "DENVER",
  "state": "CA",
  "country": "US"
}
```

--------------------------------

### Find Available Numbers by Price Range, Proximity, and Search Term

Source: https://www.numberbarn.com/api/docs/api/available-telephone-numbers

This example demonstrates how to find available phone numbers within a specific price range, near an IP address, and matching a search term. Note that price is specified in cents.

```curl
curl 'https://www.numberbarn.com/api/availableNumbers?search=POOL&$near=128.54.16.2&price[$gte]=10000&price[$lte]=50000&$limit=10'
```

--------------------------------

### C# HttpClient Example

Source: https://www.numberbarn.com/api/docs/api/remove-activate-sms

Example of deactivating SMS using HttpClient in C#. Requires a valid Bearer token for authorization.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### Request Payout (JSON Example)

Source: https://www.numberbarn.com/api/docs/api/request-payout

Use this JSON structure to request a payout. Specify the payout destination type, payout ID, amount, and status.

```json
{
  "type": "account",
  "payoutId": "Unknown Type: string[]",
  "amount": [
    "8125"
  ],
  "status": [
    "pending"
  ]
}
```

--------------------------------

### Get All NPAs

Source: https://www.numberbarn.com/api/docs/api/npas

Retrieves a list of all NPAs. By default, it returns up to 300 results. To get more, you can use the `?$limit=1000` parameter or paginate using `?$skip=300`.

```APIDOC
## Get NPAs

### Description
Retrieves a list of all NPAs. By default, it returns up to 300 results. To get more, you can use the `?$limit=1000` parameter or paginate using `?$skip=300`.

### Method
GET

### Endpoint
/api/npas

### Query Parameters
- **$limit** (integer) - Optional - The maximum number of results to return.
- **$skip** (integer) - Optional - The number of results to skip for pagination.

### Response
#### Success Response (200)
- **data** (array) - An array of NPA objects.
  - **npa** (string) - The NPA (area code).
  - **state** (string) - The state associated with the NPA.
  - **country** (string) - The country associated with the NPA.
  - **latitude** (number) - The latitude of the NPA's geographic center.
  - **longitude** (number) - The longitude of the NPA's geographic center.
  - **population** (integer) - The population of the NPA.
  - **largestCity** (string) - The largest city within the NPA.
  - **timeZone** (string) - The time zone of the NPA.
  - **isSupported** (boolean) - Indicates if the NPA is currently supported.
  - **isExhausted** (boolean) - Indicates if the NPA is exhausted.
  - **isTollFree** (boolean) - Indicates if the NPA is a toll-free number.
  - **isFuture** (boolean) - Indicates if the NPA is reserved for future use.

### Request Example
```bash
curl https://www.numberbarn.com/api/npas
```

### Response Example
```json
{
  "data": [
    {
      "npa": "201",
      "state": "NJ",
      "country": "US",
      "latitude": 40.73,
      "longitude": -74.17,
      "population": 2000000,
      "largestCity": "Newark",
      "timeZone": "Eastern",
      "isSupported": true,
      "isExhausted": false,
      "isTollFree": false,
      "isFuture": false
    }
  ]
}
```
```

--------------------------------

### Get Offers

Source: https://www.numberbarn.com/api/docs/api/get-offers

Retrieves offer details for a given telephone number. This is a GET request that returns a JSON object containing offer information.

```APIDOC
## GET /offers

### Description
Retrieves offer details for a given telephone number.

### Method
GET

### Endpoint
/offers

### Parameters
#### Query Parameters
- **uuid** (string) - Optional - The identifier of the offer.
- **tn** (string) - Optional - Telephone number.
- **formattedTn** (string) - Optional - Formatted telephone number.

### Response
#### Success Response (200)
- **uuid** (string) - The identifier of the offer.
- **tn** (string) - Telephone number.
- **formattedTn** (string) - Optional - Formatted telephone number.
- **createDate** (Date) - The create date for the offer.
- **expirationDate** (Date) - The expiration date for the offer.
- **offer** (number) - Current offer for tn in USD cents.
- **originalPrice** (number) - Original price for tn in USD cents.
- **counterOffer** (number) - Counter offer from broker for tn in USD cents.
- **initialOffer** (number) - Initial offer from buyer for tn in USD cents.
- **status** (string) - The status of the negotiation. Possible values: [`submitted`, `countered`, `accepted`, `declined`, `completed`].
- **loginToken** (string) - Authentication token if a new account was created during submission of new negotiation.

#### Response Example
```json
{
  "uuid": "12345678-abcd-abcd-abcd-12345678abcd",
  "tn": "18005550000",
  "formattedTn": "(858) 555-1212",
  "createDate": "2025-03-06T09:21:00.000Z",
  "expirationDate": "2025-03-06T09:21:00.000Z",
  "offer": 7500,
  "originalPrice": 7500,
  "counterOffer": 7500,
  "initialOffer": 7500,
  "status": "submitted",
  "loginToken": "XXXXYY"
}
```

### Error Handling
- **400** - BadRequest
- **401** - NotAuthenticated
- **402** - PaymentError
- **403** - Forbidden
- **404** - NotFound
- **405** - MethodNotAllowed
```

--------------------------------

### Date Formatting

Source: https://www.numberbarn.com/api/docs/api/numberbarn-api

Example of a date value formatted as an ISO 8601 string in UTC.

```json
{
    "createDate": "2024-01-27T21:01:01Z",
    ...
}
```

--------------------------------

### Get States API Request (C#)

Source: https://www.numberbarn.com/api/docs/api/get-states

Use this C# code to make a GET request to the states API endpoint. Ensure the HttpClient is properly configured and the response is handled.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/states/:state");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get OCNs using HttpClient in C#

Source: https://www.numberbarn.com/api/docs/api/get-ocns

This snippet demonstrates how to make a GET request to the OCNs API using HttpClient in C#. Ensure the OCN is correctly formatted in the URL.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.numberbarn.com/api/ocns/:ocn");  
request.Headers.Add("Accept", "application/json");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### Create BrokerageListings

Source: https://www.numberbarn.com/api/docs/api/listings

Creates a new broker listing. This operation is specifically for off-net listings.

```APIDOC
## Create BrokerageListings

### Description
Creates a new broker listing. Note - This only applies to off-net listings.

### Method
POST

### Endpoint
/listings
```

--------------------------------

### Get All NPAs

Source: https://www.numberbarn.com/api/docs/api/npas

Retrieve a list of all NPAs. By default, the API returns up to 300 results. To get all NPAs, you can either set a higher limit like `?$limit=1000` or paginate through the results.

```bash
curl https://www.numberbarn.com/api/npas  

```

--------------------------------

### 404 - NotFound

Source: https://www.numberbarn.com/api/docs/api/get-tns

The requested resource could not be found.

```APIDOC
## 404 - NotFound

### Description
The requested resource could not be found.

### Response
#### Success Response (404)
- **name** (string) - name of the error
- **message** (string) - message of the error
- **code** (integer) - code of the error
- **className** (string) - className of the error
- **data** (object) - data of the error
- **errors** (object) - errors of the error

### Response Example
```json
{
  "name": "name",
  "message": "message",
  "code": 404,
  "className": "className",
  "data": "data",
  "errors": "errors"
}
```
```

--------------------------------

### Create Contact using C# HttpClient

Source: https://www.numberbarn.com/api/docs/api/create-contacts

Use this snippet to create a new contact via the API using C# and HttpClient. Ensure you replace `<token>` with your actual Bearer token.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://www.numberbarn.com/api/contacts");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"tn\": \"18005550000\",\n  \"name\": \"John Doe\",\n  \"isBlocked\": true\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

```
Tokens:
Raw