Skip to main content
Get Sales Rep

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

ContactName, PersonFirstname, PersonLastname, EmailAddress, PhoneNumber

GetSalesRep: Returns the sales representative for an external user. If this method is accessed with anonymous authentication the external user is recognized by contact and name, or by email, or phone number. If the external user is recognized as an CRM5 user (internal or external) the input fields can be left blank.

ContactName
string
PersonFirstname
string
PersonLastname
string
EmailAddress
string
PhoneNumber
string

Response

OK

PersonId
integer<int32>

Primary key

Firstname
string

First name

MiddleName
string

Middle name or 'van' etc.

Lastname
string

Last name

Mrmrs
string

e.g. Mrs sex_title Use MDO List name "mrmrs" to get list items.

Title
string

Title

UpdatedDate
string<date-time>

Last updated date in UTC.

CreatedDate
string<date-time>

Registered date in UTC.

BirthDate
string<date-time>

The Person birth date as UTC Date. Year 1 = Null. Year 2 = unknown year.

CreatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Emails
object[]

A collection of the person's emails

Description
string

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

IsAssociate
boolean

Checks if the person object is an associate. The property is read-only.

PrivatePhones
object[]

Returns a collection of phone numbers that belong to the contact person.

Faxes
object[]

Returns a collection of fax numbers that belong to the contact person.

MobilePhones
object[]

Returns a collection of mobile phone numbers that belong to the contact person.

OfficePhones
object[]

Returns a collection of office phone numbers that belong to the contact person.

OtherPhones
object[]

Returns a collection of pagers that belong to the contact person.

Position
object

Carrier object for Position. Services for the Position Carrier is available from the List Agent.

UpdatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Contact
object

Carrier object for Contact. Services for the Contact Carrier is available from the Contact Agent.

Country
object

Carrier object for Country. Services for the Country Carrier is available from the List Agent.

Interests
object[]

The person's available and selected interests. Use MDO List name "persint" to get list items.

PersonNumber
string

Alphanumeric user field

FullName
string

The person's full name localized to the current culture/country. (internal name used in clients for employees)

NoMailing
boolean

Spam filter. Indicates if this person should retrieve advertising.

UsePersonAddress
boolean

True if the person's address should be used as mailing address, instead of the contact's address.

Retired
boolean

True if the user is retired and should have no rights, not appear in lists, etc.

Urls
object[]

The urls related to this person.

FormalName
string

Get formal name for a person, as used in labels. (Full name + person title + academic title)

Address
object

Street and/or Postal address, in both formatted and structured forms. You only need to modify one of the two for the change to be registered. Carrier object for Address.

Post3
string

Postal address, used in Japanese versions only

Post2
string

Postal address, used in Japanese versions only

Post1
string

Postal address, used in Japanese versions only

Kanalname
string

Kana last name, used in Japanese versions only

Kanafname
string

Kana first name, used in Japanese versions only

CorrespondingAssociate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Category
object

Carrier object for Category. Services for the Category Carrier is available from the List Agent.

Business
object

Carrier object for Business. Services for the Business Carrier is available from the List Agent.

Associate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Salutation
string

Academic title, populated from Salutation list but can be overwritten with anything at all Use MDO List name "salutation" to get list items.

ActiveInterests
integer<int32>

The number of active interests.

SupportAssociate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

TicketPriority
object

Carrier object for TicketPriority. Services for the TicketPriority Carrier is available from the List Agent.

CustomerLanguage
object

Customer languages that customer center supports. Carrier object for CustomerLanguage. Services for the CustomerLanguage Carrier is available from the List Agent.

DbiAgentId
integer<int32>

Integration agent (eJournal)

DbiKey
string

The primary key for the integrated entry in the external datasource.

DbiLastModified
string<date-time>

When the entry was last modified.

DbiLastSyncronized
string<date-time>

Last external syncronization.

SentInfo
integer<int32>

Has information on username/password been sent (ejournal)

ShowContactTickets
integer<int32>

Should tickets related to the company be shown to this person

UserInfo
object

Carrier object for UserInfo. Services for the UserInfo Carrier is available from the User Agent.

ChatEmails
object[]
InternetPhones
object[]
Source
integer<int32>

How did we get this person? For future integration needs

How many active ERP links are there for this person?

ShipmentTypes
object[]

The person's available and selected shipment types.

Consents
object[]

The person's available consent information. Missing consents are not deleted. To remove a consent, mark its legalbase as 'WITHDRAWN'

BounceEmails
string[]

Email addresses with a positive bounce counter.

ActiveStatusMonitorId
integer<int32>

Active status monitor identity with the lowest rank for person

CreatedByFormId
integer<int32>

The form id of the form that created the person

UtmParameters
object

Inital Utm parameters for a given person or contact. Carrier object for SavedUtmParameters. Services for the SavedUtmParameters Carrier is available from the Person Agent.

LeadstatusId
integer<int32>

Refinement of categories of lead type. Empty if the category is not a lead type.

Leadstatus
string

Name of leadstatus

UserDefinedFields
object

Deprecated: Use {SuperOffice.CRM.Services.PersonEntity.CustomFields} instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

ExtraFields
object

Deprecated: Use {SuperOffice.CRM.Services.PersonEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

CustomFields
object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.PersonEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.