Rivier/ Reference/ workspace

One client with its contacts

get/org/{orgId}/clients/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:read
Mcp
rivier_clients_get
Graphql
Query.workspaceOrgClientGet
Sdk
workspace.orgClient.get
Cli
clients get

Parameters

  • orgIdstring (uuid)required
    In the path
  • idstring (uuid)required
    In the path

Responses

  • 200application/json
    Success
    • clientobjectrequired
      • 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
      • contactslist of objectrequired
        • idstring (uuid)required
        • clientIdstring (uuid)required
        • namestringrequired
        • emailstringrequired
        • phonestringrequired
        • rolestringrequired
        • isPrimarybooleanrequired
        • ccDefaultbooleanrequired
        • createdAtstringrequired
  • 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