Rivier/ Reference/ workspace

The organization's clients

get/org/{orgId}/clients

The organization's clients: search by name, email or tag, active ones by default (archived: include or only), paged.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:read
Mcp
rivier_clients_list
Graphql
Query.workspaceOrgClientList
Sdk
workspace.orgClient.list
Cli
clients list

Parameters

  • orgIdstring (uuid)required
    In the path
  • qstring
    In the query
  • archivedstring
    In the query
  • limitinteger
    In the query
  • offsetinteger
    In the query

Responses

  • 200application/json
    Success
    • clientslist of objectrequired
      • idstring (uuid)required
      • organizationIdstring (uuid)required
      • namestringrequired
      • legalNamestringrequired
      • emailstringrequired
      • phonestringrequired
      • addressstringrequired
      • countrystringrequired
      • taxIdstringrequired
      • registrationstringrequired
      • currencystring or nullrequired
      • languagestringrequired
      • paymentDaysnumber or nullrequired
      • notesstringrequired
      • tagslist of stringrequired
      • projectIdstring (uuid) or nullrequired
      • createdBystringrequired
      • createdAtstringrequired
      • updatedAtstringrequired
      • archivedAtstring or nullrequired
    • totalnumberrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown