HomeGuidesAPI Reference
API Reference

Fetch customer record by reference

Fetch a customer record by a client reference.

Usage:

  • on the first onboarding init request, pass the reference in the data
  • whenever the spektrId is needed, use this endpoint to fetch the
    record using your reference
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The customer reference

Query Params
boolean

Appends the presigned file URLs to the response

boolean

Appends the ownership graph entities to the response

boolean

Adds a top-level parentIds array to the requested record. Present only when appendParentIds=true. The ids of every record that has this record as the interested party of a relation, one level up, sorted, each id once. Archived parents are included (check their status); deleted ones are not. Not to be confused with data.parentIds, a copy of form or vendor input that is never kept in sync: rely on this top-level field.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json