> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Bloomberry: Get Current Customers

> Returns a list of active customers that is subscribed to a specific tech vendor OR to ANY tech vendor in a specific category Need an API key?

Returns a list of active customers that is subscribed to a specific tech vendor OR to ANY tech vendor in a specific category Need an API key?

> [!NOTE]
>
> Tool ID: `bloomberry_get_current_customers`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'bloomberry_get_current_customers',
  {
    "next_token": "example",
    "limit": 20,
    "category": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute bloomberry_get_current_customers --input '{
  "next_token": "example",
  "limit": 20,
  "category": "example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "users": [
      {
        "id": 123,
        "domain": "example.com",
        "company_name": "Example Corp",
        "industry": "example",
        "company_size_range": "example",
        "company_size_range_estimated": true,
        "country": "US",
        "vendor_name": "Example",
        "vendor_category": "example",
        "vendor_url": "https://example.com"
      }
    ],
    "pagination": {
      "page": 123,
      "per_page": 123,
      "total_pages": 123,
      "total_items": 123
    }
  }
}
```

Use `deepline describe bloomberry_get_current_customers --json` for the latest machine-readable contract.

## Input reference

Returns a list of active customers that is subscribed to a specific tech vendor OR to ANY tech vendor in a specific category Need an API key? Get a free API key here

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.next_token` | `string` | No | — | Pagination token from previous response (located in "pagination" > "next\_token") to fetch the next page. Leave blank for the first page |
| `payload.limit` | `integer` | No | `20` | companies per page. Minimum: 1. Maximum: 20. |
| `payload.category` | `string` | No | — | The product category to get active customers for. All possible product categories are available at [https://api.revealera.com/categories.txt](https://api.revealera.com/categories.txt). Pass "all" to get customers for all categories. Note: ONLY 1 of category OR vendor\_name MUST be specified, but no more than 1. |
| `payload.vendor_name` | `string` | No | — | The name of the vendor to get current customers for. All possible vendor names can be found here: [https://api.revealera.com/vendors.txt](https://api.revealera.com/vendors.txt) . Note: ONLY 1 of category OR vendor\_name MUST be specified, but no more than 1. |
| `payload.company_employee_size_range` | `string` | No | — | Only show active customers from companies with number of employees that match the specified size ranges. Possible ranges are 1 employee, 2-10, 11-50, 51-200, 201-500, 501-1,000, 1,001-5,000, 5,001-10,000, 10,001+. Separate multiple values with semicolon. |
| `payload.company_industry` | `string` | No | — | Only show customers from companies in the industry passed in. We look at at the Linkedin company page to determine industries. All possible industries are in [https://api.revealera.com/linkedin\_industries.txt](https://api.revealera.com/linkedin_industries.txt) Separate multiple values with ';' default(all) |
| `payload.company_country` | `string` | No | — | Only show customers from companies headquartered in the country passed in. The country codes must be in ISO 3166-1 alpha-2 format. Separate multiple values with ';' default(all) |
| `payload.omit_linkedin_data` | `string` | No | `false` | true if you to omit linkedin-related fields from the response (ie for compliance reasons) |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a list of active customers that is subscribed to a specific tech vendor OR to ANY tech vendor in a specific category Need an API key? Get a free API key here",
    "properties": {
      "next_token": {
        "type": "string",
        "description": "Pagination token from previous response (located in \"pagination\" > \"next_token\") to fetch the next page. Leave blank for the first page"
      },
      "limit": {
        "type": "integer",
        "description": "companies per page.",
        "default": 20,
        "minimum": 1,
        "maximum": 20
      },
      "category": {
        "type": "string",
        "description": "The product category to get active customers for. All possible product categories are available at https://api.revealera.com/categories.txt. Pass \"all\" to get customers for all categories. Note: ONLY 1 of category OR vendor_name MUST be specified, but no more than 1."
      },
      "vendor_name": {
        "type": "string",
        "description": "The name of the vendor to get current customers for. All possible vendor names can be found here: https://api.revealera.com/vendors.txt . Note: ONLY 1 of category OR vendor_name MUST be specified, but no more than 1."
      },
      "company_employee_size_range": {
        "type": "string",
        "description": "Only show active customers from companies with number of employees that match the specified size ranges. Possible ranges are 1 employee, 2-10, 11-50, 51-200, 201-500, 501-1,000, 1,001-5,000, 5,001-10,000, 10,001+. Separate multiple values with semicolon."
      },
      "company_industry": {
        "type": "string",
        "description": "Only show customers from companies in the industry passed in. We look at at the Linkedin company page to determine industries. All possible industries are in https://api.revealera.com/linkedin_industries.txt Separate multiple values with ';' default(all)"
      },
      "company_country": {
        "type": "string",
        "description": "Only show customers from companies headquartered in the country passed in. The country codes must be in ISO 3166-1 alpha-2 format. Separate multiple values with ';' default(all)"
      },
      "omit_linkedin_data": {
        "type": "string",
        "description": "true if you to omit linkedin-related fields from the response (ie for compliance reasons)",
        "default": false
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.users` | `array` | Yes | — | Array of tech signal objects |
| `result.data.users[].id` | `integer` | Yes | — | Customer ID |
| `result.data.users[].linkedin_username` | `string` | No | — | LinkedIn username of the company |
| `result.data.users[].linkedin_company_id` | `string` | No | — | LinkedIn company id of the company |
| `result.data.users[].domain` | `string` | Yes | — | Company domain/website of the company |
| `result.data.users[].company_name` | `string` | Yes | — | Name of the company |
| `result.data.users[].company_logo` | `string` | No | — | URL to company logo |
| `result.data.users[].company_address` | `string` | No | — | Company address, if found |
| `result.data.users[].industry` | `string` | Yes | — | Company industry of the company |
| `result.data.users[].company_size_range` | `string` | Yes | — | Company size range |
| `result.data.users[].company_size_range_estimated` | `boolean` | Yes | — | true if the company\_size\_range was estimated by us, or false if it was taken directly from their Linkedin company profile |
| `result.data.users[].company_description` | `string` | No | — | Company description |
| `result.data.users[].country` | `string` | Yes | — | Company country |
| `result.data.users[].vendor_name` | `string` | Yes | — | Name of the technology vendor |
| `result.data.users[].vendor_category` | `string` | Yes | — | Category of the vendor/technology |
| `result.data.users[].vendor_url` | `string` | Yes | — | URL to vendor website |
| `result.data.users[].usage_started_at` | `string` | No | — | Date in which we detected this customer first started usage of this vendor in YYYY-MM-DD format |
| `result.data.users[].plan_name` | `string \| null` | No | — | the name of the product plan this customer is currently in (most of the time it is null, but if we know it, it is indicated here) |
| `result.data.pagination` | `object` | Yes | — | — |
| `result.data.pagination.page` | `integer` | Yes | — | Current page number |
| `result.data.pagination.per_page` | `integer` | Yes | — | Number of items per page |
| `result.data.pagination.total_pages` | `integer` | Yes | — | Total number of pages |
| `result.data.pagination.total_items` | `integer` | Yes | — | Total number of items |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "users": {
            "type": "array",
            "description": "Array of tech signal objects",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "Customer ID"
                },
                "linkedin_username": {
                  "type": "string",
                  "description": "LinkedIn username of the company"
                },
                "linkedin_company_id": {
                  "type": "string",
                  "description": "LinkedIn company id of the company"
                },
                "domain": {
                  "type": "string",
                  "description": "Company domain/website of the company"
                },
                "company_name": {
                  "type": "string",
                  "description": "Name of the company"
                },
                "company_logo": {
                  "type": "string",
                  "description": "URL to company logo"
                },
                "company_address": {
                  "type": "string",
                  "description": "Company address, if found"
                },
                "industry": {
                  "type": "string",
                  "description": "Company industry of the company"
                },
                "company_size_range": {
                  "type": "string",
                  "description": "Company size range"
                },
                "company_size_range_estimated": {
                  "type": "boolean",
                  "description": "true if the company_size_range was estimated by us, or false if it was taken directly from their Linkedin company profile"
                },
                "company_description": {
                  "type": "string",
                  "description": "Company description"
                },
                "country": {
                  "type": "string",
                  "description": "Company country"
                },
                "vendor_name": {
                  "type": "string",
                  "description": "Name of the technology vendor"
                },
                "vendor_category": {
                  "type": "string",
                  "description": "Category of the vendor/technology"
                },
                "vendor_url": {
                  "type": "string",
                  "description": "URL to vendor website"
                },
                "usage_started_at": {
                  "type": "string",
                  "description": "Date in which we detected this customer first started usage of this vendor in YYYY-MM-DD format"
                },
                "plan_name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "the name of the product plan this customer is currently in (most of the time it is null, but if we know it, it is indicated here)"
                }
              },
              "required": [
                "id",
                "domain",
                "company_name",
                "industry",
                "company_size_range",
                "company_size_range_estimated",
                "country",
                "vendor_name",
                "vendor_category",
                "vendor_url"
              ],
              "additionalProperties": false
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "page": {
                "type": "integer",
                "description": "Current page number"
              },
              "per_page": {
                "type": "integer",
                "description": "Number of items per page"
              },
              "total_pages": {
                "type": "integer",
                "description": "Total number of pages"
              },
              "total_items": {
                "type": "integer",
                "description": "Total number of items"
              }
            },
            "required": [
              "page",
              "per_page",
              "total_pages",
              "total_items"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "users",
          "pagination"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `2.11` per pricing unit.

## Related documentation

* [Bloomberry provider guide](https://deepline.com/docs/providers/bloomberry/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.