> ## 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 Contact Summary > Get summary of contact and its recent activity. ## OpenAPI ````yaml /openapi/rest/openapi-v3-Contact.json get /api/v1/Contact/{contactId}/Summary openapi: 3.0.0 info: version: v1-REST title: SuperOffice REST API v1 description: SuperOffice REST API - Contact 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/Contact/{contactId}/Summary: get: tags: - Contact summary: Get Contact Summary description: Get summary of contact and its recent activity. operationId: v1ContactEntity_GetContactSummary parameters: - name: contactId in: path description: The contact id to summarize. required: true schema: type: integer format: int32 - name: limit in: query description: Max number of items to include in summary lists. required: false schema: type: integer format: int32 - 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 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactSummary' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactSummary' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactSummary' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactSummary' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactSummary' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactSummary' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.CRM.Services.ContactSummary: description: "Summary of contact with recent activities, chats, and requests included.\r\n\r\nCarrier object for ContactSummary.\r\nServices for the ContactSummary Carrier is available from the Contact Agent." type: object properties: Contact: $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact' Tickets: description: Recent tickets on contact type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketSummaryItem' Followups: description: Recent follow-ups on contact type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ActivitySummaryItem' Documents: description: Recent documents on contact type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ActivitySummaryItem' Sales: description: Recent sales on contact type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.SaleSummaryItem' Chats: description: Recent chats with contact type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatSummaryItem' 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.TicketSummaryItem: description: "The ticket summary with heading, created date.\r\n\r\nCarrier object for TicketSummaryItem.\r\nServices for the TicketSummaryItem Carrier is available from the Ticket Agent." type: object properties: TicketId: format: int32 description: The primary key (auto-incremented) type: integer TicketStatus: format: int32 description: User defined ticket status type: integer Title: description: The title of the ticket. type: string Registered: format: date-time description: When the ticket was created. type: string IconHint: description: Icon representing ticket's state type: string SuperOffice.CRM.Services.ActivitySummaryItem: description: "Summary details about appointments and documents.\r\n\r\nCarrier object for ActivitySummaryItem.\r\nServices for the ActivitySummaryItem Carrier is available from the Appointment Agent." type: object properties: AppointmentId: format: int32 description: Primary key type: integer DocumentId: format: int32 description: Document id - 0 if not a document type: integer Date: format: date-time description: Start/Document date type: string Description: description: The appointment's textbox; document title type: string Completed: description: The Completed state. NotStarted(1) or Completed(3) enum: - Unknown - NotStarted - Started - Completed type: string Registered: format: date-time description: Registered date in UTC. type: string SuperOffice.CRM.Services.SaleSummaryItem: description: "Sale Summary item \r\n\r\nCarrier object for SaleSummaryItem.\r\nServices for the SaleSummaryItem Carrier is available from the Sale Agent." type: object properties: SaleId: format: int32 description: Primary key type: integer SaleDate: format: date-time description: Expected sales date type: string Probability: format: int32 description: Probability of sale succeess in percent (0-100) type: integer Heading: description: Sale heading (short description?) type: string Amount: format: double description: Total sale amount type: number Currency: description: Currency the sale amount is in. type: string AmountInBaseCurrency: format: double description: Sale amount converted to the base currency. type: number Status: description: >- The sale's status, indicating whether the sale is open(1), sold(2) or lost(3). enum: - Unknown - Open - Sold - Lost - Stalled - SaintAll type: string Completed: description: The Completed state. NotStarted(1) or Completed(3) enum: - Unknown - NotStarted - Started - Completed type: string Registered: format: date-time description: Registered date in UTC. type: string SuperOffice.CRM.Services.ChatSummaryItem: description: "Chat session summary: id, title, created date\r\n\r\nCarrier object for ChatSummaryItem.\r\nServices for the ChatSummaryItem Carrier is available from the Chat Agent." type: object properties: ChatSessionId: format: int32 description: The primary key (auto-incremented) type: integer Name: description: The name of customer, if provided type: string CompanyName: description: The name of the customers company, if provided type: string FirstMessage: description: A copy of the first message in the chat session type: string LastMessage: description: A copy of the last message in the chat session type: string WhenRequested: format: date-time description: When the session was requested by the customer. type: string WhenEnded: format: date-time description: When the session was ended. type: string 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.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 - [Get Contact Summary](/en/api/reference/restful/agent/contact_agent/get-contact-summary.md) - [NSContactAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSContactAgent.md) - [SuperOffice.WebApi.Data.Contact GetContactSummaryRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Contact_GetContactSummaryRequest.md) - [SuperOffice.WebApi.Agents.ContactAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ContactAgent.md) - [Activities](/en/automation/crmscript/howto/company/get-activities.md) - [SuperOffice.WebApi.Agents.IContactAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IContactAgent.md)