> ## 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 > OData list of all ContactRelationEntity. Can be sorted and further filtered using OData conventions: * Relation?$select=col1,col2,abc/col3 * Relation?$filter=col1 eq 'foo' and startswith(col2, 'baz') * Relation?$orderby=abc/col3,col1 * Relation?$top=1000 * Relation?$mode=full OData returns XML or JSON carriers depending on the Accept headers. Calls the Archive service using the "Relation" archive. ## Filter Operators: ## ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between strings: contains, is, notBegins, notContains, isNot associate: associateIsOneOf, associateIsNotOneOf, list ids: oneOf, NotOneOf, dates: before, date, after, dateBetween, beforeToday Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period) ## OpenAPI ````yaml /openapi/rest/openapi-v3-Relation.json get /api/v1/Relation openapi: 3.0.0 info: version: v1-REST title: SuperOffice REST API v1 description: SuperOffice REST API - Relation 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/Relation: get: tags: - ContactRelation summary: Get All description: "OData list of all ContactRelationEntity.\n\nCan be sorted and further filtered using OData conventions:\r\n\r\n* Relation?$select=col1,col2,abc/col3\r\n* Relation?$filter=col1 eq 'foo' and startswith(col2, 'baz')\r\n* Relation?$orderby=abc/col3,col1\r\n* Relation?$top=1000\r\n* Relation?$mode=full\r\n\r\n\r\nOData returns XML or JSON carriers depending on the Accept headers.\r\n\r\n\r\nCalls the Archive service using the \"Relation\" archive.\r\n\r\n\r\n## Filter Operators: ##\r\n\r\nints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between\r\n\r\nstrings: contains, is, notBegins, notContains, isNot\r\n\r\nassociate: associateIsOneOf, associateIsNotOneOf, \r\n\r\nlist ids: oneOf, NotOneOf, \r\n\r\ndates: before, date, after, dateBetween, beforeToday\r\n\r\nUnary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear\r\n\r\nFuncs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)\r\n" operationId: v1ContactRelationEntity_GetAll parameters: - name: $select in: query description: >- Comma separated list of column names to return. "nameDepartment,fullname,category". Can also use aggregation functions and modifiers: "Count(category):Footer" required: false schema: type: string - name: $filter in: query description: >- Expression to restrict the results. e.g.: "name begins 'foo' and category gt 1" required: false schema: type: string - name: $orderBy in: query description: >- Comma separated list of column names to sort by, with optional direction. "name asc,fullname,category desc" required: false schema: type: string - name: $entities in: query description: >- Comma separated list of entity names to use. Default = "". "contact, person" required: false schema: type: string - name: $top in: query description: Number of rows to return in results required: false schema: type: integer format: int32 - name: $skip in: query description: Number of rows from database to skip before returning results required: false schema: type: integer format: int32 - name: $mode in: query description: >- FULL (with raw values and hints for each value) or SLIM (just the display values) required: false schema: type: string enum: - Slim - Wide - Full - name: $options in: query description: 'Provider specific options. e.g: "GrandTotal=true"' required: false schema: type: string - name: $context in: query description: Provider specific context parameter. required: false schema: type: string - name: $format in: query description: >- Set XML or JSON output format; override the format determined from Accept header. required: false schema: type: string - name: $jsonSafe in: query description: >- Make output names into JSON safe property names. Replace all unsafe characters with _ underscore. required: false schema: type: boolean - name: $output in: query description: >- Return Logical or Display values in SLIM mode. Logical returns true/false for booleans, Display returns icon hints. Dates are always returned as ISO strings. required: false schema: type: string enum: - Logical - Display - 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.Services.WebApi.OData.ODataSlimResponse text/json: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse application/xml: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse text/xml: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.Services.WebApi.OData.ODataSlimResponse: description: Easy to use archive results - just a flat list of values. type: object properties: odata.metadata: type: string odata.nextLink: type: string value: type: array items: type: object additionalProperties: type: object ```` ## Related topics - [Get All](/en/api/reference/restful/rest/list_priority/get-all.md)