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

# Search an external database table

> Returns the rows of one table of a database, with a count.

Send the `table_name` at the top level of the body. The response, under `external_database`, holds `count`, `limit`, `offset` and a `list` object keyed by table name, where each row maps column names to values. No filter fields are documented yet; with only `table_name`, the call returns the table's rows.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml POST /external_databases/{db_name}/search
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /external_databases/{db_name}/search:
    post:
      tags:
        - External databases
      summary: Search an external database table
      description: >-
        Send the `table_name` at the top level of the body. The response, under
        `external_database`, holds `count`, `limit`, `offset` and a `list`
        object keyed by table name, where each row maps column names to values.
        No filter fields are documented yet; with only `table_name`, the call
        returns the table's rows.
      operationId: external_databases_create_external_database_search
      parameters:
        - name: db_name
          in: path
          required: true
          description: >-
            The database's `name`, as given when it is created, such as
            `acmedb`.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                table_name:
                  type: string
            example:
              table_name: contacts
      responses:
        '200':
          description: The matching rows, under `external_database.list`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDatabaseSearchResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            "$EXSITED_BASE_URL/api/v4/external_databases/acmedb/search" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "table_name": "contacts"
              }'
        - lang: python
          label: Python
          source: >
            from exsited import build_client


            client = build_client()


            response =
            client.external_databases.create_external_database_search(
                "acmedb", {"table_name": "contacts"}
            )

            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.externalDatabases.createExternalDatabaseSearch('acmedb',
            {table_name: 'contacts'});

            console.log(response.data);
        - lang: php
          label: PHP
          source: >
            use Exsited\Client\ClientRegistry;


            $client = ClientRegistry::buildClient();


            $response =
            $client->externalDatabases->createExternalDatabaseSearch('acmedb', [
                'table_name' => 'contacts',
            ]);

            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import
            com.exsited.resources.external_databases.external_databases_dto.ExternalDatabasesDto.ExternalDatabaseSearch;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<ExternalDatabaseSearch> response =
            client.externalDatabases().createExternalDatabaseSearch(
                    "acmedb",
                    Map.of("table_name", "contacts"));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.ExternalDatabases.CreateExternalDatabaseSearchAsync(
                "acmedb",
                new Dictionary<string, object?> { ["table_name"] = "contacts" });

            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: >
            import 'package:exsited/exsited.dart';


            final client = buildClient();


            final response = await
            client.externalDatabases.createExternalDatabaseSearch(
              'acmedb',
              {'table_name': 'contacts'},
            );

            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.ExternalDatabases().CreateExternalDatabaseSearch(context.Background(), \"acmedb\", map[string]any{\"table_name\": \"contacts\"}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    ExternalDatabaseSearchResponse:
      type: object
      properties:
        external_database:
          $ref: '#/components/schemas/ExternalDatabaseSearchResult'
    ExternalDatabaseSearchResult:
      type: object
      properties:
        success:
          type: boolean
        count:
          type: integer
          description: The number of rows found.
        limit:
          type: integer
        offset:
          type: integer
        list:
          type: object
          description: >-
            One array of rows per table name; each row maps column names to
            values.
          additionalProperties:
            type: array
            items:
              type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

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