Get All Contact Relations

Gets the relations for use with a contact.

Resource Information

Scopecontacts

Deprecated scope name:   get_settings_contact_relations

App TypeAll
Authorization TypeAccess token
URI /v4/settings/contacts/relations?lang={lang}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNo Indicates the language applied.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.textstringThe localized display text.7.3.2
result.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "value": "Agent",
      "text": "Agent"
    },
    {
      "value": "Applicant",
      "text": "Applicant"
    },
    {
      "value": "Attorney",
      "text": "Attorney"
    },
    {
      "value": "Billing Contact",
      "text": "Billing Contact"
    },
    {
      "value": "Business Owner",
      "text": "Business Owner"
    },
    {
      "value": "Complainant",
      "text": "Complainant"
    },
    {
      "value": "Contact",
      "text": "Contact"
    },
    {
      "value": "Developer",
      "text": "Developer"
    },
    {
      "value": "Director",
      "text": "Director"
    },
    {
      "value": "Hearing Body Member",
      "text": "Hearing Body Member"
    },
    {
      "value": "License Holder",
      "text": "License Holder"
    },
    {
      "value": "Officer",
      "text": "Officer"
    },
    {
      "value": "Respondent",
      "text": "Respondent"
    },
    {
      "value": "Shareholder",
      "text": "Shareholder"
    },
    {
      "value": "Tenant",
      "text": "Tenant"
    }
  ]
}