Skip to main content
GET
Resolve the effective contact for a target
SystemUser accessible. Required policy actions:
  • ContactGroupService:resolveContactPreview

Authorizations

Authorization
string
header
required

JWT bearer token obtained from POST /auth/system-login using your client credentials.

Query Parameters

contactGroupFor
enum<string>
required

Target type to resolve from.

Available options:
customer,
entity,
contract,
invoice
contactGroupForId
string
required

Id of the target record to resolve from.

purpose
enum<string> | null

Document type to resolve for. Omit for a generic ("All") resolution.

Available options:
invoice,
credit_note,
dunning,
null

Response

Success

status
string
Example:

"success"

message
string
Example:

"Success"

data
object | null

Endpoint-specific payload (object, array, or null)