GET api/v1/ContactCompanies?primaryContactEmail={primaryContactEmail}

A list of ContactCompanies where the Contact with the provided email address is primary contact.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
primaryContactEmail

Email address of the primary contact

string

Required

Body Parameters

None.

Response Information

Resource Description

A list of ContactCompanies

Collection of ReadContactCompanyDto
NameDescriptionTypeAdditional information
Id

Company id

integer

Required

Name

Company name

string

Required

String length: inclusive between 1 and 255

PrimaryContactId

ID of the primary contact

integer

None.

ContactCompanyId

Id of parent company. Used when the company is a subsidiary or department of another company. Only 2 levels are allowed (Parent company and subsidiary/department)

integer

None.

EmailDomains

Domains from which the company send emails (as comma separated string)

string

Max length: 2000

Logo

URL to the company's logo

string

Max length: 500

Number

Your Id for the company (optional) It must be unique or null

string

Max length: 25

LastModified

When the contact company was last updated

date

Required

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "PrimaryContactId": 1,
    "ContactCompanyId": 1,
    "EmailDomains": "sample string 3",
    "Logo": "sample string 4",
    "Number": "sample string 5",
    "LastModified": "2024-03-28T07:05:57.855464+00:00"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "PrimaryContactId": 1,
    "ContactCompanyId": 1,
    "EmailDomains": "sample string 3",
    "Logo": "sample string 4",
    "Number": "sample string 5",
    "LastModified": "2024-03-28T07:05:57.855464+00:00"
  }
]