Search

Endpointhttps://api.kontier.eu/v1

Global search across billing entities.

Global search

GET

https://api.kontier.eu/v1

/search

Free-text search across customers and their related records. A customer's name is denormalised onto their invoices and credit notes, so querying a customer name surfaces that customer (ranked first) together with their related records. Results are scoped to the caller's organization and workspace and filtered to the entity types the caller is permitted to read.

Required scope: search.read (Search across data).

Global search › query Parameters

include

string[] · explode: true

Extra data to add to the response: customer, data, tags. Send a comma-separated list or repeat the parameter. An unknown name is refused with 400. data is sent without being asked until 2026-11-30; after that date it is sent only when named here. tags is sent without being asked until 2026-11-30; after that date it is sent only when named here.

Enum values:

customer

data

tags

q

string

Free-text query (matches display_name, searchable, secondary_text)

types

string

Comma-separated entity types to include (customer,product,invoice). Defaults to all.

limit

integer · min: 1

Max hits to return (default 50, max 200)

Example: 50

cursor

string

Opaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.

tag

string

Filter by tag id or name (repeatable)

Global search › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

Global search › Responses

data

array | null · required

object · required

GET/search

curl --request GET \
  --url https://api.kontier.eu/v1/search

shell

Example Responses

{
  "data": [
    {
      "customer": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name"
      },
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "customer_name": "customer_name",
      "display_name": "display_name",
      "entity_type": "customer",
      "id": "00000000-0000-0000-0000-000000000000",
      "reference": "reference",
      "score": 0,
      "secondary_text": "secondary_text",
      "tag_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name"
        }
      ]
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Customer search overview

GET

https://api.kontier.eu/v1

/search/customer-overview

Returns a single customer's profile plus a recency-ordered preview of their related records (invoices, credit notes, ...), grouped by entity type. Groups are limited to the entity types the caller may read; results are scoped to the caller's organization and workspace.

Required scope: search.read (Search across data).

Customer search overview › query Parameters

include

string[] · explode: true

Enum values:

customer

data

tags

customer_id

string

Customer UUID to build the overview for

limit

integer · min: 1

Max records previewed per group (default 5, max 20)

Example: 50

Customer search overview › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Customer search overview › Responses

object · required

GET/search/customer-overview

curl --request GET \
  --url https://api.kontier.eu/v1/search/customer-overview

shell

Example Responses

{
  "data": {
    "customer": {
      "customer": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name"
      },
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "customer_name": "customer_name",
      "display_name": "display_name",
      "entity_type": "customer",
      "id": "00000000-0000-0000-0000-000000000000",
      "reference": "reference",
      "score": 0,
      "secondary_text": "secondary_text",
      "tag_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name"
        }
      ]
    },
    "groups": [
      {
        "entity_type": "customer",
        "has_more": true,
        "hits": [
          {
            "customer": {
              "id": "00000000-0000-0000-0000-000000000000",
              "name": "name"
            },
            "customer_id": "00000000-0000-0000-0000-000000000000",
            "customer_name": "customer_name",
            "display_name": "display_name",
            "entity_type": "customer",
            "id": "00000000-0000-0000-0000-000000000000",
            "reference": "reference",
            "score": 0,
            "secondary_text": "secondary_text",
            "tag_ids": [
              "00000000-0000-0000-0000-000000000000"
            ],
            "tags": [
              {
                "id": "00000000-0000-0000-0000-000000000000",
                "name": "name"
              }
            ]
          }
        ]
      }
    ],
    "profile": {
      "customer": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name"
      },
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "customer_name": "customer_name",
      "display_name": "display_name",
      "entity_type": "customer",
      "id": "00000000-0000-0000-0000-000000000000",
      "reference": "reference",
      "score": 0,
      "secondary_text": "secondary_text",
      "tag_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name"
        }
      ]
    }
  }
}

json

application/json

Test Payment Simulations Portal

Global search

GET

https://api.kontier.eu/v1

/search

Required scope: search.read (Search across data).

Global search › query Parameters

include

string[] · explode: true

Enum values:

customer

data

tags

q

string

Free-text query (matches display_name, searchable, secondary_text)

types

string

Comma-separated entity types to include (customer,product,invoice). Defaults to all.

limit

integer · min: 1

Max hits to return (default 50, max 200)

Example: 50

cursor

string

tag

string

Filter by tag id or name (repeatable)

Global search › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Global search › Responses

data

array | null · required

object · required

Customer search overview

GET

https://api.kontier.eu/v1

/search/customer-overview

Required scope: search.read (Search across data).

Customer search overview › query Parameters

include

string[] · explode: true

Enum values:

customer

data

tags

customer_id

string

Customer UUID to build the overview for

limit

integer · min: 1

Max records previewed per group (default 5, max 20)

Example: 50

Customer search overview › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Customer search overview › Responses

object · required