Search Peppol participants

GET

/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/directory/search

Search for Peppol participants in the directory.

Authorizations

• HTTPBearer
• HTTPBearer

Parameters

Query Parameters

query

Any of:

string

string

null

null

Search by name, tax ID, or participant ID

country_code

Any of:

string

string

<= 2 characters

null

null

page

Page

integer

default: 1 >= 1

page_size

Page Size

integer

default: 20 >= 1 <= 100

Header Parameters

X-Workspace-ID

Any of:

string

string

null

null

X-API-Key

Any of:

string

string

null

null

Responses

200

Successful Response

Examples

200 response example

{
  "status": "ok",
  "message": "Request completed successfully."
}

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}