> ## 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 Ref Count Entity > Gets a RefCountEntity object. NsApiSlow threshold: 1000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-NumberAllocationAgent.json post /api/v1/Agents/NumberAllocation/GetRefCountEntity openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - NumberAllocationAgent 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/NumberAllocation/GetRefCountEntity: post: tags: - NumberAllocation_Agent summary: Get Ref Count Entity description: |- Gets a RefCountEntity object. NsApiSlow threshold: 1000 ms. operationId: v1NumberAllocationAgent_GetRefCountEntity parameters: - name: refCountEntityId in: query description: The identifier of the RefCountEntity object required: true schema: type: integer format: int32 - 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.RefCountEntity' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.RefCountEntity' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.RefCountEntity' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.RefCountEntity' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.RefCountEntity' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.RefCountEntity' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.CRM.Services.RefCountEntity: description: "A refcount entity for a number allocation\r\n\r\nCarrier object for RefCountEntity.\r\nServices for the RefCountEntity Carrier is available from the NumberAllocation Agent." type: object properties: RefCountsId: format: int32 description: Primary key type: integer Field: description: Field identifier in string format table.field type: string RecordId: format: int32 description: >- Record id in target table, used when there are separate counters for each target record type: integer SuggestedRecords: description: >- List of valid entities, the associated record is selected in the list, used records are filtered out type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' CurrentValue: format: int32 description: Current value of counter type: integer TravelPrefix: format: int32 description: size of prefix for Travel use of ths counter type: integer SatPrefix: format: int32 description: size of prefix for Satellite use of this counter type: integer Allocate: description: Allocate numbers automatically type: boolean Unique: description: Check that entered value is unique type: boolean ReadOnly: description: Target field is read only in GUI type: boolean AllowBlank: description: Allow blank as a valid value 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.MDOListItem: description: "Carrier object for MDOListItem.\r\nServices for the MDOListItem Carrier is available from the MDO Agent." type: object properties: Id: format: int32 description: The Id of the ListItem type: integer Name: description: The name of the ListItem type: string ToolTip: description: The tooltip of the ListItem type: string Deleted: description: The deleted status of the ListItem type: boolean Rank: format: int32 description: The rank of the ListItem type: integer Type: description: The type of the ListItem. Custom field. type: string ChildItems: description: The child items of the MDOListItem type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' IconHint: description: The Icon hint of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer ExtraInfo: description: >- Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field. type: string StyleHint: description: >- Style hint indicating, information such as background color etc. Custom field. type: string FullName: description: The name of the ListItem in its context 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.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 - [SuperOffice.WebApi.Data.RefCountEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.RefCountEntity.md) - [NSNumberAllocationAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSNumberAllocationAgent.md) - [SuperOffice.WebApi.Agents.INumberAllocationAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.INumberAllocationAgent.md) - [SuperOffice.WebApi.Agents.NumberAllocationAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.NumberAllocationAgent.md) - [NSRefCountEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSRefCountEntity.md) - [Get Entity Counts For All Users](/en/api/reference/restful/agent/diagnostics_agent/get-entity-counts-for-all-users.md)