> ## 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 List Entity > Gets a ListEntity object. Calls the List agent service GetListEntity. NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/rest/openapi-v3-List.json get /api/v1/List/{id} openapi: 3.0.0 info: version: v1-REST title: SuperOffice REST API v1 description: SuperOffice REST API - List 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/List/{id}: get: tags: - List_ summary: Get List Entity description: "Gets a ListEntity object.\n\nCalls the List agent service GetListEntity.\r\nNsApiSlow threshold: 5000 ms." operationId: v1ListEntity_GetListEntity parameters: - name: id in: path description: The id of the ListEntity to return. 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: ListEntity found. content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.ListEntityWithLinks text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.ListEntityWithLinks application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.ListEntityWithLinks text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.ListEntityWithLinks application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.ListEntityWithLinks application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.ListEntityWithLinks '404': description: Not Found. security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.ListCarriers.ListEntityWithLinks: description: "The list entity contains information about a specific list\r\n\r\nListEntity entity with API _Links added." type: object properties: Id: format: int32 description: The identity of the list type: integer Name: description: The name of the list type: string Tooltip: description: The tooltip of the list type: string Deleted: description: True if the list item is marked as deleted type: boolean Rank: format: int32 description: The rank of the list type: integer IsCustomList: description: Indicates if this is a custom list or a standard list type: boolean IsMDOList: description: Indicates if this is a MDO list type: boolean UseGroupsAndHeadings: description: Indicates if this list should use groups and headings type: boolean ListType: description: >- The type of this list, often indicated by the database name, but not necessarily type: string InUseByUserDefinedFields: description: True if this in use by one or more udfields 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' _Links: type: object additionalProperties: 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 List Entity](/en/api/reference/restful/agent/list_agent/get-list-entity.md) - [Get List Entity By Name](/en/api/reference/restful/rest/list_/get-list-entity-by-name.md) - [How to get list entity by name](/en/api/lists/services/how-to/get-list-entity.md) - [NSListEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSListEntity.md) - [Get Currency Entity](/en/api/reference/restful/rest/list_currency/get-currency-entity.md)