> ## 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 Project Entity > Gets a ProjectEntity object. NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-ProjectAgent.json post /api/v1/Agents/Project/GetProjectEntity openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - ProjectAgent 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/Project/GetProjectEntity: post: tags: - Project_Agent summary: Get Project Entity description: |- Gets a ProjectEntity object. NsApiSlow threshold: 2000 ms. operationId: v1ProjectAgent_GetProjectEntity parameters: - name: projectEntityId in: query description: The identifier of the ProjectEntity object required: true schema: format: int32 type: integer - 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 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectEntity' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectEntity' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectEntity' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectEntity' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectEntity' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectEntity' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.CRM.Services.ProjectEntity: description: "The Project Service. The service implements all services working with the Project object\r\n\r\nCarrier object for ProjectEntity.\r\nServices for the ProjectEntity Carrier is available from the Project Agent." type: object properties: ProjectId: format: int32 description: Primary key type: integer Name: description: Project name type: string ProjectNumber: description: Automatically generated number type: string ProjectMembers: description: The persons which are members of the project type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectMember' Urls: description: The project's internet adresses type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement' CreatedDate: format: date-time description: Registered date in UTC. type: string UpdatedDate: format: date-time description: Last updated date in UTC. type: string Description: description: >- The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases type: string Postit: description: >- The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases type: string CreatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' UpdatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Associate: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' ProjectStatus: $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectStatus' ProjectType: $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectType' HasImage: description: >- True if the project has an image. (This is the image that is displayed in the CRM client) type: boolean ImageDescription: description: >- Description of the project image if it exists. (This is the image that is displayed in the CRM client) type: string ActiveStatusMonitorId: format: int32 description: Active status monitor identity with the lowest rank for project type: integer Links: description: List of all elements linked to the project type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.Link' ActiveLinks: format: int32 description: Number of active links to documents, other appointments, and such type: integer Completed: description: >- Done (0=false, 1=true). Status implies changes in which fields are shown in GUI, as well as which fields can be updated type: boolean NextMilestoneDate: format: date-time description: >- Calculated date, reflects date of closest non-complete future milestone activity type: string NmdAppointmentId: format: int32 description: ID of appointment that "caused" the nextMilestoneDate, can be 0 type: integer EndDate: format: date-time description: Planned end date for project, inhertied from type and later editable type: string ActiveErpLinks: format: int32 description: The number of active erp links type: integer EventId: format: int32 description: Reserved field for Lyyti event when project is linked to an event. type: integer StartDate: format: date-time description: >- Reserved field for Lyyti event when project is linked to an event, is the event start date. type: string UserDefinedFields: description: "Deprecated: Use {SuperOffice.CRM.Services.ProjectEntity.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.ProjectEntity.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.ProjectEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string PublishEventDate: format: date-time description: Publish event date type: string PublishTo: format: date-time description: Publication valid to (inclusive) type: string PublishFrom: format: date-time description: Publication valid from (inclusive) type: string IsPublished: description: Publication is published 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.ProjectMember: description: "A person can be a member of multiple projects, with a different comment and member type in each project.\r\n\r\nCarrier object for ProjectMember.\r\nServices for the ProjectMember Carrier is available from the Project Agent." type: object properties: ProjectmemberId: format: int32 description: Primary key type: integer ContactId: format: int32 description: Contact ID of person who is the project member type: integer ProjectId: format: int32 description: Parent project - the project this project member belongs to. type: integer ContactName: description: Contact name type: string ContactDepartment: description: Contact department type: string ProjectName: description: Name of the project this project member belongs to. type: string EmailId: format: int32 description: The person's email address id type: integer EmailAddress: description: The e-mail address type: string CountryId: format: int32 description: Country type: integer Firstname: description: First name type: string MiddleName: description: Middle name or 'van' etc. type: string Lastname: description: Last name type: string PersonId: format: int32 description: The person's id - primary key type: integer Mrmrs: description: e.g. Mrs, Dr, Ms. type: string ProjectMemberTypeName: description: 'The projectmembers type name: ''secretary'', ''member'', etc.' type: string Phone: description: Phone number type: string PhoneId: format: int32 description: The phone id type: integer ProjectMemberTypeId: format: int32 description: "ProjectMember Type Id - from the ProjectMemberType list. \r\nUse MDO List name \"PMembType\" to get list items." type: integer EmailAddressName: description: The e-mail address description type: string Comment: description: Comment text on the project membership type: string FullName: description: >- The person's full name localized to the current culture/country. (internal name used in clients for employees) type: string Registered: format: date-time description: The date and time when the project member was registered in UTC. type: string Updated: format: date-time description: The date and time when the project member was last updated in UTC. type: string EventParticipantStatus: description: Reserved field for Lyyti event participants. enum: - NotAnEvent - NotReacted - ReactedNo - ReactedYes - Show - NoShow 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.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.ProjectStatus: description: "Carrier object for ProjectStatus.\r\nServices for the ProjectStatus 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.ProjectType: description: "Carrier object for ProjectType.\r\nServices for the ProjectType 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.Link: description: "Links two entities (contacts/projects/sales/URLs) together.\r\n\r\nCarrier object for Link.\r\nServices for the Link Carrier is available from the List Agent." type: object properties: EntityName: description: >- Name of the entity the link points to (The destination/target entity) type: string Id: format: int32 description: >- Id of the entity the link points to (The destination/target entity primary key) type: integer Description: description: Link description. type: string ExtraInfo: description: >- Extrainfo for link. Use for information that does not have a primary key type: string LinkId: format: int32 description: Primary key type: integer 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.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 Project Entity](/en/api/reference/restful/rest/project/get-project-entity.md) - [Get Project Entity Without Members](/en/api/reference/restful/agent/project_agent/get-project-entity-without-members.md) - [NSProjectAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSProjectAgent.md) - [SuperOffice.WebApi.Data.Project GetProjectEntityWithoutMembersRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Project_GetProjectEntityWithoutMembersRequest.md) - [NSProjectEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSProjectEntity.md) - [Get Project Event Entity From Project Id](/en/api/reference/restful/agent/project_agent/get-project-event-entity-from-project-id.md)