> ## 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 Person Summary > Get summary of person and recent activity. ## OpenAPI ````yaml /openapi/rest/openapi-v3-Person.json get /api/v1/Person/{personId}/Summary openapi: 3.0.0 info: version: v1-REST title: SuperOffice REST API v1 description: SuperOffice REST API - Person 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/Person/{personId}/Summary: get: tags: - Person summary: Get Person Summary description: Get summary of person and recent activity. operationId: v1PersonEntity_GetPersonSummary parameters: - name: personId in: path description: The person 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.PersonSummary' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonSummary' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonSummary' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonSummary' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonSummary' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PersonSummary' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.CRM.Services.PersonSummary: description: "Summary of person, with recent activities, chats, and requests included.\r\n\r\nCarrier object for PersonSummary.\r\nServices for the PersonSummary Carrier is available from the Person Agent." type: object properties: Person: $ref: '#/components/schemas/SuperOffice.CRM.Services.Person' Tickets: description: Recent tickets on person type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketSummaryItem' Followups: description: Recent follow-ups on person type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ActivitySummaryItem' Documents: description: Recent documents on person type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ActivitySummaryItem' Sales: description: Recent sales on person type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.SaleSummaryItem' Chats: description: Recent chats with person type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatSummaryItem' SuperOffice.CRM.Services.Person: description: "Carrier object for Person.\r\nServices for the Person Carrier is available from the Person Agent." type: object properties: Position: description: >- The position. This is a predefined SuperOffice value, different from Title type: string PersonId: format: int32 description: Primary key type: integer Mrmrs: description: e.g. Mrs sex_title type: string Firstname: description: First name type: string Lastname: description: Last name type: string MiddleName: description: Middle name or 'van' etc. type: string Title: description: Title type: string Description: description: Info text/description on person. type: string Email: description: First email on contact person. type: string FullName: description: >- Get the persons full name (internal name used in clients for employees). type: string DirectPhone: description: Returns the direct phone that belong to the contact person. type: string FormalName: description: >- Get formal name for a person, as used in labels. (Full name + person title + academic title) type: string CountryId: format: int32 description: Country type: integer ContactId: format: int32 description: Owning contact ID type: integer ContactName: description: The persons company name type: string Retired: format: int32 description: >- 1 = the user is retired and should have no rights, not appear in lists, etc. type: integer Rank: format: int32 description: Display sort sequence for default sort order type: integer ActiveInterests: format: int32 description: >- Number of records in pintr table; select count(*) from pintr pi where pi.person_id = this.person_id == activeInterests is always true type: integer ContactDepartment: description: The persons contact department type: string ContactCountryId: format: int32 description: The persons contact country id type: integer ContactOrgNr: description: The persons contact organization number type: string FaxPhone: description: Returns the fax phone that belong to the contact person. type: string MobilePhone: description: Returns the mobile phone that belong to the contact person. type: string ContactPhone: description: Returns the direct phone that belong to the persons contact. type: string AssociateName: description: Name of the person's owner type: string AssociateId: format: int32 description: Id of the item's owner (Associate id) type: integer UsePersonAddress: description: If 1, use person's address for mailing instead of company address type: boolean ContactFax: description: Actual phone number as eneterd by the user type: string Kanafname: description: Kana first name, used in Japanese versions only type: string Kanalname: description: Kana last name, used in Japanese versions only type: string Post1: description: Postal address, used in Japanese versions only type: string Post2: description: Postal address, used in Japanese versions only type: string Post3: description: Postal address, used in Japanese versions only type: string EmailName: description: E-mail description type: string ContactFullName: description: Company full name + department type: string ActiveErpLinks: format: int32 description: How many active ERP links are there for this person? type: integer TicketPriorityId: format: int32 description: Ticket priority ID type: integer SupportLanguageId: format: int32 description: Support priority ID type: integer SupportAssociateId: format: int32 description: Our support contact for this person type: integer CategoryName: description: The category list item name type: string PersonNumber: 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.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.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 Person Summary](/en/api/reference/restful/agent/person_agent/get-person-summary.md) - [SuperOffice.WebApi.Data.Person GetPersonSummaryRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Person_GetPersonSummaryRequest.md) - [NSPersonAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSPersonAgent.md) - [SuperOffice.WebApi.Agents.PersonAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.PersonAgent.md) - [SuperOffice.WebApi.Agents.IPersonAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IPersonAgent.md) - [Get Person](/en/api/reference/restful/agent/person_agent/get-person.md)