# searchCompanies

**Identifier:** `pappers_searchCompanies`

**Provider:** [Pappers](https://kirha.com/providers/pappers.md)

Search for French companies by name, SIREN, or other criteria using Pappers database.

## Run it with the CLI

```bash
kirha tools run pappers_searchCompanies \
  --input '{
    "query": "<query>"
  }'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "pappers_searchCompanies",
  "input": {
    "query": "<query>"
  }
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "activityCode": {
      "description": "Filter by NAF activity code",
      "type": "string"
    },
    "city": {
      "description": "Filter by city name",
      "type": "string"
    },
    "department": {
      "description": "Filter by department code",
      "type": "string"
    },
    "legalForm": {
      "description": "Filter by legal form (e.g., SAS, SARL, SA)",
      "type": "string"
    },
    "limit": {
      "default": 5,
      "description": "Maximum number of results to return",
      "maximum": 25,
      "minimum": 1,
      "type": "number"
    },
    "query": {
      "description": "Provide only one search term: either a company name or a SIREN number or a search term. Do not combine multiple types.",
      "minLength": 1,
      "type": "string"
    },
    "region": {
      "description": "Filter by region",
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "companies": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "activityCode": {
            "type": "string"
          },
          "activityLabel": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "creationDate": {
            "type": "string"
          },
          "legalForm": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "siren": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "siren",
          "name"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "context": {
      "type": "string"
    },
    "totalResults": {
      "type": "number"
    }
  },
  "required": [
    "context",
    "companies",
    "totalResults"
  ],
  "type": "object"
}
```

-----

[All Pappers tools](https://kirha.com/providers/pappers.md) · [< Back to tools list](https://kirha.com/tools.md)