> ## 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 All
> Gets a list of all PreferenceDescriptions in the system.
NsApiSlow threshold: 1000 ms.
## OpenAPI
````yaml /openapi/agent/openapi-v3-PreferenceAgent.json post /api/v1/Agents/Preference/GetAll
openapi: 3.0.0
info:
version: v1-Agents
title: SuperOffice Agent API v1
description: SuperOffice Agent API - PreferenceAgent
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/Preference/GetAll:
post:
tags:
- Preference_Agent
summary: Get All
description: |-
Gets a list of all PreferenceDescriptions in the system.
NsApiSlow threshold: 1000 ms.
operationId: v1PreferenceAgent_GetAll
parameters:
- 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:
type: array
items:
$ref: >-
#/components/schemas/SuperOffice.CRM.Services.PreferenceDescription
text/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/SuperOffice.CRM.Services.PreferenceDescription
application/xml:
schema:
type: array
items:
$ref: >-
#/components/schemas/SuperOffice.CRM.Services.PreferenceDescription
text/xml:
schema:
type: array
items:
$ref: >-
#/components/schemas/SuperOffice.CRM.Services.PreferenceDescription
application/json-patch+json:
schema:
type: array
items:
$ref: >-
#/components/schemas/SuperOffice.CRM.Services.PreferenceDescription
application/merge-patch+json:
schema:
type: array
items:
$ref: >-
#/components/schemas/SuperOffice.CRM.Services.PreferenceDescription
security:
- SuperOffice_Password: []
SuperId_Authentication: []
components:
schemas:
SuperOffice.CRM.Services.PreferenceDescription:
description: "Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.\r\n\r\nCarrier object for PreferenceDescription.\r\nServices for the PreferenceDescription Carrier is available from the Preference Agent."
type: object
properties:
PrefDescId:
format: int32
description: Primary key
type: integer
Section:
description: Preference section name
type: string
Key:
description: Preference key name
type: string
Name:
description: Multi-language name
type: string
ValueType:
description: >-
1=number, 2=text, 3=bool, 4=list of values; 5=list table ref;
6=contact ID, 7=Person ID, 8=Project ID, 9=Selection ID
enum:
- Unknown
- Number
- Text
- Bool
- ListOfValues
- ListTableRef
- TimeList
- ContactID
- PersonID
- ProjectID
- SelectionID
- PosSize
- TimeZone
- Time
- Password
- MultiLineText
type: string
MaxLevel:
description: >-
Lowest allowed setting level, set by user, but not lower than
sysMaxLevel
enum:
- Undefined
- HardDefault
- SystemWide
- Database
- Group
- Individual
- PC
type: string
SysMaxLevel:
description: Lowest allowed setting level, set by SuperOffice
enum:
- Undefined
- HardDefault
- SystemWide
- Database
- Group
- Individual
- PC
type: string
AccessFlags:
description: 1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui
enum:
- Unknown
- WizardMode
- Level0
- adminGUI
- CRMGUI
type: string
Description:
description: Description of preference, multi-language parsed
type: string
IsBuiltin:
description: 1 = This row populated and maintained by SuperOffice
type: boolean
TableName:
description: >-
If valueType = 5, then TableName contains the table referenced by
the preference
type: string
UserDefinedListId:
format: int32
description: >-
Read-only field, If valueType = 5, and TableName is UDList, then
UserdefinedLIstId contains the id of the list referenced by the
preference
type: integer
Rank:
format: int32
description: Rank field for ordering sections, and keys within sections
type: integer
SubGroup:
description: >-
Keys that share a value (including NULL) in this field are shown
together; a visual spacer is shown between groups
type: string
MinLevel:
format: int32
description: >-
The minimum (furthest away from User) level this preference can be
set for
type: integer
MaxValue:
format: int32
description: Max value (if type 1); list table ID (if type 5)
type: integer
MinValue:
format: int32
description: Min value (if type 1); list extra id (if type 5)
type: integer
RequiredLicense:
description: >-
Licenses the user/installation must have if this reference is to be
shown. Comma-separated list of owner.module pairs
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
- [Get All](/en/api/reference/restful/rest/list_priority/get-all.md)