Rivier/ Reference/ contacts

The platform's customers, by ref or address

get/platform-customers

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:read
Graphql
Query.contactsPlatformCustomerList
Sdk
contacts.platformCustomer.list
Cli
contacts platform customer list

Parameters

  • refstring
    In the query
  • emailstring
    In the query
  • limitinteger
    In the query

Responses

  • 200application/json
    Success
    • 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