List parties

GET

/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/parties

List all parties (suppliers/customers) with pagination and filtering.

Authorizations

• HTTPBearer
• HTTPBearer

Parameters

Query Parameters

page

Page

integer

default: 1 >= 1

page_size

Page Size

integer

default: 20 >= 1 <= 100

party_type

Any of:

string

string

null

null

search

Any of:

string

string

null

null

Search by name or tax ID

is_active

Any of:

boolean

boolean

null

null

is_peppol_participant

Any of:

boolean

boolean

null

null

sort_by

Any of:

string

string

null

null

sort_order

Any of:

string

string

/^(asc|desc)$/

null

null

Header Parameters

X-Workspace-ID

Any of:

string

string

null

null

X-API-Key

Any of:

string

string

null

null

X-Tenant-ID

Any of:

string

string

null

null

Responses

200

Successful Response

Examples

Customer directory response

{
  "items": [
    {
      "id": "8a1c7f6c-61a1-4d89-8d96-3f7e7747f0c0",
      "legal_name": "Optimum Business Solution Ltd",
      "trading_name": "OBS",
      "party_type": "customer",
      "tax_id": "TIN-12345678",
      "email": "ap@obs.ng",
      "phone": "+2348012345678",
      "is_peppol_participant": true
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 50
}

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"
    }
  ]
}