GET v1/Companies({CompanyId})/CustomerFull({CustomerId})

This call returns the Full Customer by id, including Addresses, Contact info, Extended Attributes, Documents, etc.

Information:

Base URL:

https://api.covasoft.net/crm

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyId

Company Id from your onboarding package

integer

Required

CustomerId

GUID for Customer from the GET customers Call

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns all the Customers in a Company

CustomerDetailsReturn
NameDescriptionTypeAdditional information
Addresses

Collection of Address

None.

ContactMethods

Collection of ContactMethod

None.

CustomerExtensions

Collection of CustomerExtension

None.

RelatedCustomers

Collection of Object

None.

MemberOf

Collection of Object

None.

Documents

Collection of Object

None.

MergedCustomers

Collection of Object

None.

PrimaryName

string

None.

Title

string

None.

AlternateName

string

None.

MiddleName

string

None.

FamilyName

string

None.

ReferralSource

Object

None.

Notes

string

None.

UniqueIdentifier

string

None.

Id

globally unique identifier

None.

CustomerTypeId

integer

None.

CustomerType

string

None.

DateOfBirth

Object

None.

PricingGroupId

Object

None.

Disabled

boolean

None.

DoNotContact

boolean

None.

Version

integer

None.

MergedIntoCustomerId

Object

None.

LastModifiedDateUtc

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Addresses": [
    {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "0d99d633-70c8-48c5-abfd-fbc26f272f70",
      "CustomerId": "cc5563b6-8ed4-4cb4-966f-0d7b56e726b4",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    },
    {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "0d99d633-70c8-48c5-abfd-fbc26f272f70",
      "CustomerId": "cc5563b6-8ed4-4cb4-966f-0d7b56e726b4",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    }
  ],
  "ContactMethods": [
    {
      "Value": "sample string 1",
      "Id": "a5782190-1e9c-4aef-934f-c6c4c5654105",
      "CustomerId": "3d6fbc0b-a4c1-4a9d-94a0-792869204c06",
      "ContactMethodCategoryId": 4,
      "ContactMethodCategory": "sample string 5",
      "ContactMethodTypeId": 6,
      "ContactMethodType": "sample string 7",
      "DoNotContact": true,
      "Default": true,
      "Notes": "sample string 10",
      "Version": 11
    },
    {
      "Value": "sample string 1",
      "Id": "a5782190-1e9c-4aef-934f-c6c4c5654105",
      "CustomerId": "3d6fbc0b-a4c1-4a9d-94a0-792869204c06",
      "ContactMethodCategoryId": 4,
      "ContactMethodCategory": "sample string 5",
      "ContactMethodTypeId": 6,
      "ContactMethodType": "sample string 7",
      "DoNotContact": true,
      "Default": true,
      "Notes": "sample string 10",
      "Version": 11
    }
  ],
  "CustomerExtensions": [
    {
      "Value": "sample string 1",
      "Id": "4558573c-bcc1-457a-8d98-aaa5d10e1566",
      "CustomerId": "745a9f95-e799-46c8-b847-3fe0a2645c03",
      "ExtensionTypeId": 4,
      "ExtensionType": "sample string 5",
      "ExtensionTypeFeature": "sample string 6",
      "Version": 7
    },
    {
      "Value": "sample string 1",
      "Id": "4558573c-bcc1-457a-8d98-aaa5d10e1566",
      "CustomerId": "745a9f95-e799-46c8-b847-3fe0a2645c03",
      "ExtensionTypeId": 4,
      "ExtensionType": "sample string 5",
      "ExtensionTypeFeature": "sample string 6",
      "Version": 7
    }
  ],
  "RelatedCustomers": [
    {},
    {}
  ],
  "MemberOf": [
    {},
    {}
  ],
  "Documents": [
    {},
    {}
  ],
  "MergedCustomers": [
    {},
    {}
  ],
  "PrimaryName": "sample string 1",
  "Title": "sample string 2",
  "AlternateName": "sample string 3",
  "MiddleName": "sample string 4",
  "FamilyName": "sample string 5",
  "ReferralSource": {},
  "Notes": "sample string 7",
  "UniqueIdentifier": "sample string 8",
  "Id": "d0cfa0e8-964f-45ee-b8a7-6604ce21a07a",
  "CustomerTypeId": 10,
  "CustomerType": "sample string 11",
  "DateOfBirth": {},
  "PricingGroupId": {},
  "Disabled": true,
  "DoNotContact": true,
  "Version": 16,
  "MergedIntoCustomerId": {},
  "LastModifiedDateUtc": "2024-11-25T11:28:52.3418096+00:00"
}