Get Contact Entity
Gets a ContactEntity object.
Calls the Contact agent service GetContactEntity. NsApiSlow threshold: 2000 ms.
Authorizations
SuperOffice username:password are passed in Base64-encoded.
You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.
SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/
passing in the application id and redirect URL.
SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)
https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f
You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.
- Authorization URL
- https://online.superoffice.com/login/common/oauth/authorize
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Path Parameters
The id of the ContactEntity to return.
Query Parameters
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.
Load foreign keys on this entity into the ExtraFields property as 'app.device.keyname'='123' pairs.
Response
ContactEntity found.
The Contact Service. The service implements all services working with the Contact object ContactEntity entity with API _Links added.
Primary key
Contact name
Department
VAT number or similar
Alphanumeric user field
Alphanumeric user field
Date last updated in UTC.
Date registered in UTC.
The contact's email
The contact's available and selected interests. Use MDO List name "contint" to get list items.
The contact's internet adresses
The contact's phone numbers
The contact's fax numbers
Description of the contact. Usually shown as a postit note.
Description of what the company does, for later agent/LLM use
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Carrier object for Business. Services for the Business Carrier is available from the List Agent.
Carrier object for Category. Services for the Category Carrier is available from the List Agent.
Carrier object for Country. Services for the Country Carrier is available from the List Agent.
The persons belonging to the contact.
Spam filter. Indicates if this contact should retrieve advertising.
Contact kana name, used in Japanese versions only
STOP flag
The number of active interests.
Group id of original owning associate, semantics like appnt.grp_id
Active status monitor identity with the lowest rank for contact
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Carrier object for TicketPriority. Services for the TicketPriority Carrier is available from the List Agent.
Customer languages that customer center supports. Carrier object for CustomerLanguage. Services for the CustomerLanguage Carrier is available from the List Agent.
If nonzero, then this contact is 'deleted' and should generally not be shown
Integration agent (eJournal)
Last external syncronization.
The primary key for the integrated entry in the external datasource.
When the entry was last modified.
Carrier object for Person. Services for the Person Carrier is available from the Person Agent.
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.
How did we get this contact? For future integration needs
The number of active erp links
Approximate number of employees working in this company
The year the company was founded
The year the revenue was recorded
Revenue converted to base currency
Capital invested in the company, in base currency
Name of the source of the data, for traceability
The LinkedIn URL for the company
Email addresses with a positive bounce counter.
Web domains for this contact, ordered in array by rank
Inital Utm parameters for a given person or contact. Carrier object for SavedUtmParameters. Services for the SavedUtmParameters Carrier is available from the Person Agent.
Deprecated: Use {SuperOffice.CRM.Services.ContactEntity.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"
Deprecated: Use {SuperOffice.CRM.Services.ContactEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.
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.ContactEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.