> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Sales Rep > 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. NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-PersonAgent.json post /api/v1/Agents/Person/GetSalesRep openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - PersonAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Person/GetSalesRep: post: tags: - Person_Agent summary: Get Sales Rep description: "Returns the sales representative for an external user.\n\nIf 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.\r\nNsApiSlow threshold: 2000 ms." operationId: v1PersonAgent_GetSalesRep parameters: - name: $select in: query description: >- 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. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetSalesRepRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetSalesRepRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetSalesRepRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetSalesRepRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetSalesRepRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetSalesRepRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetSalesRepRequest description: >- ContactName, PersonFirstname, PersonLastname, EmailAddress, PhoneNumber required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonEntity' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonEntity' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonEntity' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonEntity' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonEntity' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonEntity' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetSalesRepRequest: description: >- 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. type: object properties: ContactName: type: string PersonFirstname: type: string PersonLastname: type: string EmailAddress: type: string PhoneNumber: type: string SuperOffice.CRM.Services.PersonEntity: description: '' type: object properties: PersonId: format: int32 description: Primary key type: integer Firstname: description: First name type: string MiddleName: description: Middle name or 'van' etc. type: string Lastname: description: Last name type: string Mrmrs: description: "e.g. Mrs sex_title \r\nUse MDO List name \"mrmrs\" to get list items." type: string Title: description: Title type: string UpdatedDate: format: date-time description: Last updated date in UTC. type: string CreatedDate: format: date-time description: Registered date in UTC. type: string BirthDate: format: date-time description: >- The Person birth date as UTC Date. Year 1 = Null. Year 2 = unknown year. type: string CreatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Emails: description: A collection of the person's emails type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' Description: description: >- The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases type: string IsAssociate: description: >- Checks if the person object is an associate. The property is read-only. type: boolean PrivatePhones: description: >- Returns a collection of phone numbers that belong to the contact person. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' Faxes: description: >- Returns a collection of fax numbers that belong to the contact person. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' MobilePhones: description: >- Returns a collection of mobile phone numbers that belong to the contact person. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' OfficePhones: description: >- Returns a collection of office phone numbers that belong to the contact person. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' OtherPhones: description: Returns a collection of pagers that belong to the contact person. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' Position: $ref: '#/components/schemas/SuperOffice.CRM.Services.Position' UpdatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Contact: $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact' Country: $ref: '#/components/schemas/SuperOffice.CRM.Services.Country' Interests: description: "The person's available and selected interests. \r\nUse MDO List name \"persint\" to get list items." type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem PersonNumber: description: Alphanumeric user field type: string FullName: description: >- The person's full name localized to the current culture/country. (internal name used in clients for employees) type: string NoMailing: description: Spam filter. Indicates if this person should retrieve advertising. type: boolean UsePersonAddress: description: >- True if the person's address should be used as mailing address, instead of the contact's address. type: boolean Retired: description: >- True if the user is retired and should have no rights, not appear in lists, etc. type: boolean Urls: description: The urls related to this person. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' FormalName: description: >- Get formal name for a person, as used in labels. (Full name + person title + academic title) type: string Address: $ref: '#/components/schemas/SuperOffice.CRM.Services.Address' Post3: description: Postal address, used in Japanese versions only type: string Post2: description: Postal address, used in Japanese versions only type: string Post1: description: Postal address, used in Japanese versions only type: string Kanalname: description: Kana last name, used in Japanese versions only type: string Kanafname: description: Kana first name, used in Japanese versions only type: string CorrespondingAssociate: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Category: $ref: '#/components/schemas/SuperOffice.CRM.Services.Category' Business: $ref: '#/components/schemas/SuperOffice.CRM.Services.Business' Associate: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Salutation: description: "Academic title, populated from Salutation list but can be overwritten with anything at all \r\nUse MDO List name \"salutation\" to get list items." type: string ActiveInterests: format: int32 description: The number of active interests. type: integer SupportAssociate: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' TicketPriority: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketPriority' CustomerLanguage: $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomerLanguage' DbiAgentId: format: int32 description: Integration agent (eJournal) type: integer DbiKey: description: The primary key for the integrated entry in the external datasource. type: string DbiLastModified: format: date-time description: When the entry was last modified. type: string DbiLastSyncronized: format: date-time description: Last external syncronization. type: string SentInfo: format: int32 description: Has information on username/password been sent (ejournal) type: integer ShowContactTickets: format: int32 description: Should tickets related to the company be shown to this person type: integer UserInfo: $ref: '#/components/schemas/SuperOffice.CRM.Services.UserInfo' ChatEmails: description: '' type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' InternetPhones: description: '' type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' Source: format: int32 description: How did we get this person? For future integration needs type: integer ActiveErpLinks: format: int32 description: How many active ERP links are there for this person? type: integer ShipmentTypes: description: The person's available and selected shipment types. type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem Consents: description: >- The person's available consent information. Missing consents are not deleted. To remove a consent, mark its legalbase as 'WITHDRAWN' type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ConsentInfo' BounceEmails: description: Email addresses with a positive bounce counter. type: array items: type: string ActiveStatusMonitorId: format: int32 description: Active status monitor identity with the lowest rank for person type: integer CreatedByFormId: format: int32 description: The form id of the form that created the person type: integer UtmParameters: $ref: '#/components/schemas/SuperOffice.CRM.Services.SavedUtmParameters' LeadstatusId: format: int32 description: >- Refinement of categories of lead type. Empty if the category is not a lead type. type: integer Leadstatus: description: Name of leadstatus type: string UserDefinedFields: description: "Deprecated: Use {SuperOffice.CRM.Services.PersonEntity.CustomFields} instead.\r\nDictionary of user defined field data.\r\nThe 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\"" type: object additionalProperties: type: string ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.PersonEntity.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.PersonEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Associate: description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the Associate Agent." type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\nUse MDO List name \"person\" to get list items." type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.EntityElement: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Position: description: "Carrier object for Position.\r\nServices for the Position Carrier is available from the List Agent." type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Contact: description: "Carrier object for Contact.\r\nServices for the Contact Carrier is available from the Contact Agent." type: object properties: ContactId: format: int32 description: Primary key type: integer Name: description: Contact name type: string OrgNr: description: VAT number or similar type: string Department: description: Department type: string URL: description: The internet address to this contact type: string City: description: City corresponding to zip code type: string DirectPhone: description: The contacts phone type: string AssociateId: format: int32 description: Our contact type: integer CountryId: format: int32 description: Country type: integer EmailAddress: description: The contact email address type: string Kananame: description: Contact kana name, used in Japanese versions only type: string EmailAddressName: description: Visible field type: string URLName: description: Visible field type: string AssociateFullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string BusinessName: description: The business list item name type: string CategoryName: description: The category list item name type: string CountryName: description: Name of country in installed language type: string Address: $ref: '#/components/schemas/SuperOffice.CRM.Services.Address' FormattedAddress: description: >- The contact's address, formatted with linebreaks and spaces into a single string. type: string FullName: description: '' type: string IsOwnerContact: description: >- Is the contact an owner contact. This means that all persons on this contact can on only be internal users and not external users. type: boolean ActiveErpLinks: format: int32 description: The number of active erp links type: integer Number1: description: Alphanumeric user field type: string Number2: description: Alphanumeric user field type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Country: description: "Carrier object for Country.\r\nServices for the Country Carrier is available from the List Agent." type: object properties: CountryId: format: int32 description: Primary key type: integer Name: description: Name of country in installed language type: string CurrencyId: format: int32 description: Default currency for this country type: integer EnglishName: description: Name of country in english type: string TwoLetterISOCountry: description: Two-letter country-code according to ISO3166 type: string ThreeLetterISOCountry: description: Three-letter country-code according to ISO3166 type: string ImageDescription: description: >- Description of the country's flag image. (This is the country flag that is displayed in the CRM client) type: string OrgNrText: description: Lead text for organisation field type: string InterAreaPrefix: description: International prefix type: string DialInPrefix: description: Dial in prefix type: string ZipPrefix: description: Post prefix type: string DomainName: description: Domain name of the country type: string AddressLayoutId: format: int32 description: Address layout of the country type: integer DomesticAddressLayoutId: format: int32 description: Domestic address layout of the country type: integer ForeignAddressLayoutId: format: int32 description: Foreign address layout of the country type: integer Rank: format: int32 description: The rank of the country type: integer Tooltip: description: The tooltip of the country type: string Deleted: description: true if the country is deleted type: boolean TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.SelectableMDOListItem: description: "Carrier object for SelectableMDOListItem.\r\nServices for the SelectableMDOListItem Carrier is available from the MDO Agent." type: object properties: Id: format: int32 description: The Id of the ListItem type: integer Name: description: The name of the ListItem type: string ToolTip: description: The tooltip of the ListItem type: string Deleted: description: The deleted status of the ListItem type: boolean Rank: format: int32 description: The rank of the ListItem type: integer Type: description: The type of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer IconHint: description: The Icon hint of the ListItem. Custom field. type: string Selected: description: True if the ListItem is selected type: boolean LastChanged: format: date-time description: Time of last change. type: string ChildItems: description: The child items of the SelectableMDOListItem type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem ExtraInfo: description: >- Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field. type: string StyleHint: description: >- Style hint indicating, information such as background color etc. Custom field. type: string Hidden: description: True if the ListItem is hidden type: boolean FullName: description: The name of the ListItem in its context type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Address: description: "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.\r\n\r\nCarrier object for Address." type: object properties: Wgs84Latitude: format: double description: >- Latitude (that's north/south), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 59.91892. This value needs no further grid reference or other qualifying information. type: number Wgs84Longitude: format: double description: >- Longitude (that's East/west), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 10.73159. This value needs no further grid reference or other qualifying information. type: number LocalizedAddress: description: >- LocalizedFieldArray is a list of LocalizedFieldList objects. Used to store localized information such as formatted address data. type: array items: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.LocalizedField' Street: $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress' Postal: $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress' Formatted: description: >- Read-only formatted address multi-line string. Combines street and postal into one string. e.g.: "Postboks 123,\nBrugata 123,\n1234 OSLO\n" or "Postbox 123,\nBridgelane 123,\nWest Tooting,\nEast Shire ES2 W31\n". type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Category: description: "Carrier object for Category.\r\nServices for the Category Carrier is available from the List Agent." type: object properties: Id: format: int32 description: The category identifier type: integer Value: description: The category name type: string Tooltip: description: The category description type: string CategoryGroup: description: Enum of the group this category belongs to, static list of 5 groups enum: - Unknown - Customer - PotentialCustomer - Partner - Lost - Other type: string EnableLeadStatus: description: True if the category should enable lead status type: boolean Rank: format: int32 description: The rank of the category type: integer Deleted: description: True if the category is deleted type: boolean TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Business: description: "Carrier object for Business.\r\nServices for the Business Carrier is available from the List Agent." type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.TicketPriority: description: "Carrier object for TicketPriority.\r\nServices for the TicketPriority Carrier is available from the List Agent." type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.CustomerLanguage: description: "Customer languages that customer center supports.\r\n\r\nCarrier object for CustomerLanguage.\r\nServices for the CustomerLanguage Carrier is available from the List Agent." type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.UserInfo: description: "Carrier object for UserInfo.\r\nServices for the UserInfo Carrier is available from the User Agent." type: object properties: Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean UserInfoId: format: int32 description: Primary key type: integer UserName: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: Owning person record type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string UserGroupId: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserType: description: '' enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GrantedLicenses: description: '' type: array items: type: string CanLogon: description: '' type: boolean RoleName: description: '' type: string RoleTooltip: description: '' type: string UserGroupName: description: '' type: string UserGroupTooltip: description: '' type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.ConsentInfo: description: "Consent information for a give person. Consents are for a particular Purpose, and may be withdrawn (see LegalBase).\r\n\r\nCarrier object for ConsentInfo.\r\nServices for the ConsentInfo Carrier is available from the Person Agent." type: object properties: ConsentPersonId: format: int32 description: Primary key type: integer Comment: description: Comment regarding this specific consent type: string Registered: format: date-time description: When this consent record was created in UTC. type: string RegisteredAssociateId: format: int32 description: The ID of the associate who created this record type: integer Updated: format: date-time description: When this consent record was last updated in UTC. type: string UpdatedAssociateId: format: int32 description: The ID of the associate who last updated this record type: integer LegalBaseId: format: int32 description: Primary key for the LegalBase associated with this consent type: integer LegalBaseKey: description: Key for the LegalBase associated with this consent type: string LegalBaseName: description: Name of the LegalBase associated with this consent type: string ConsentPurposeId: format: int32 description: Primary key for the ConsentPurpose associated with this consent type: integer ConsentPurposeKey: description: Key of the ConsentPurpose associated with this consent type: string ConsentPurposeName: description: Name of the ConsentPurpose associated with this consent type: string ConsentSourceId: format: int32 description: Primary key for the ConsentSource associated with this consent type: integer ConsentSourceKey: description: Key of the ConsentSource associated with this consent type: string ConsentSourceName: description: Name of the ConsentSource associated with this consent type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.SavedUtmParameters: description: "Inital Utm parameters for a given person or contact.\r\n\r\nCarrier object for SavedUtmParameters.\r\nServices for the SavedUtmParameters Carrier is available from the Person Agent." type: object properties: FormName: description: The name of form for the first submission type: string FirsttouchSource: description: First touch UTM source type: string FirsttouchMedium: description: First touch UTM medium type: string FirsttouchCampaign: description: First touch UTM campaign type: string FirsttouchTerm: description: First touch UTM term type: string FirsttouchContent: description: First touch UTM content type: string FirsttouchReferrerDomain: description: First touch UTM referrer domain type: string Source: description: UTM source type: string Medium: description: UTM medium type: string Campaign: description: UTM campaign type: string Term: description: UTM term type: string Content: description: UTM content type: string ReferrerDomain: description: UTM referrer domain type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Services.LocalizedField: description: "LocalizedField is used to store localized information such as formatted address data, a formatted phone number, etc.\r\n\r\nCarrier object for LocalizedField." type: object properties: Name: description: Name of the value field type: string Value: description: The field's value type: string Tooltip: description: The tooltip type: string Label: description: The label of the field type: string ValueLength: format: int32 description: Database length of the value type: integer AddressType: description: '' type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.StructuredAddress: description: "Address with structured fields (Address1, City, Zip) - does not vary its layout by country, unliked the formatted address.\r\n\r\nCarrier object for StructuredAddress." type: object properties: AtypeIdx: description: >- Bit mask, combines address type (EAddressType) and owner type (EOwnerType) enum: - Unknown - ContactPostalAddress - ContactStreetAddress - PersonPrivateAddress - QuoteBillingAddress - QuoteShippingAddress type: string Address1: description: Address line 1 type: string Address2: description: Address line 2 type: string Address3: description: Address line 3 type: string City: description: City corresponding to zip code type: string County: description: County (not country) type: string State: description: State type: string Zipcode: description: Zip code, alphanumeric type: string Formatted: description: >- Read-only formatted address multi-line string. e.g.: "Brugata 123,\n1234 OSLO\n" or "Bridgelane 123,\nWest Tooting,\nThe Shire ES2 W31\n". type: string SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.Person GetSalesRepRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Person_GetSalesRepRequest.md) - [NSSalesActivity](/en/automation/crmscript/reference/CRMScript.NetServer.NSSalesActivity.md) - [NSPersonAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSPersonAgent.md) - [Approve sale](/en/mobile/sale/approve-quote.md) - [Use board view in selections](/en/search-options/selection/learn/board-view.md) - [SuperOffice.WebApi.Data.SalesActivity](/en/api/reference/webapi/SuperOffice.WebApi.Data.SalesActivity.md)