> ## 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 Contact List

> Gets an array of Contact objects.

NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ContactAgent.json post /api/v1/Agents/Contact/GetContactList
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ContactAgent
  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/Contact/GetContactList:
    post:
      tags:
        - Contact_Agent
      summary: Get Contact List
      description: |-
        Gets an array of Contact objects.

        NsApiSlow threshold: 2000 ms.
      operationId: v1ContactAgent_GetContactList
      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
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                format: int32
                type: integer
          text/json:
            schema:
              type: array
              items:
                format: int32
                type: integer
          application/xml:
            schema:
              type: array
              items:
                format: int32
                type: integer
          text/xml:
            schema:
              type: array
              items:
                format: int32
                type: integer
          application/x-www-form-urlencoded:
            schema:
              type: array
              items:
                format: int32
                type: integer
          application/json-patch+json:
            schema:
              type: array
              items:
                format: int32
                type: integer
          application/merge-patch+json:
            schema:
              type: array
              items:
                format: int32
                type: integer
        description: The identifiers of the Contact object
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact'
            application/json-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact'
            application/merge-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.Contact:
      description: "Carrier object for Contact.\r\nServices for the Contact Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IContactAgent\">Contact Agent</see>."
      type: object
      properties:
        ContactId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: Contact name
          type: string
        OrgNr:
          description: VAT number or similar
          type: string
        Department:
          description: Department
          type: string
        URL:
          description: The internet address to this contact
          type: string
        City:
          description: City corresponding to zip code
          type: string
        DirectPhone:
          description: The contacts phone
          type: string
        AssociateId:
          format: int32
          description: Our contact
          type: integer
        CountryId:
          format: int32
          description: Country
          type: integer
        EmailAddress:
          description: The contact email address
          type: string
        Kananame:
          description: Contact kana name, used in Japanese versions only
          type: string
        EmailAddressName:
          description: Visible field
          type: string
        URLName:
          description: Visible field
          type: string
        AssociateFullName:
          description: >-
            The associate's culture formatted fullname (firstname, middleName
            and lastname)
          type: string
        BusinessName:
          description: The business list item name
          type: string
        CategoryName:
          description: The category list item name
          type: string
        CountryName:
          description: Name of country in installed language
          type: string
        Address:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Address'
        FormattedAddress:
          description: >-
            The contact's address, formatted with linebreaks and spaces into a
            single string.
          type: string
        FullName:
          description: ''
          type: string
        IsOwnerContact:
          description: >-
            Is the contact an owner contact.  This means that all persons on
            this contact can on only be internal users and not external users.
          type: boolean
        ActiveErpLinks:
          format: int32
          description: The number of active erp links
          type: integer
        Number1:
          description: Alphanumeric user field
          type: string
        Number2:
          description: Alphanumeric user field
          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.Address:
      description: "Street and/or Postal address, in both formatted and structured forms. You only need to modify one of the two for the change to be registered.\r\n<para />\r\nCarrier object for Address."
      type: object
      properties:
        Wgs84Latitude:
          format: double
          description: >-
            Latitude (that's north/south), decimal degrees, relative to WGS 84
            ellipsoid. SuperOffice ASA is at 59.91892. This value needs no
            further grid reference or other qualifying information.
          type: number
        Wgs84Longitude:
          format: double
          description: >-
            Longitude (that's East/west), decimal degrees, relative to WGS 84
            ellipsoid. SuperOffice ASA is at 10.73159. This value needs no
            further grid reference or other qualifying information.
          type: number
        LocalizedAddress:
          description: >-
            LocalizedFieldArray is a list of LocalizedFieldList objects. Used to
            store localized information such as formatted address data.
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.LocalizedField'
        Street:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress'
        Postal:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress'
        Formatted:
          description: >-
            Read-only formatted address multi-line string. Combines street and
            postal into one string. e.g.: <c>"Postboks 123,\nBrugata 123,\n1234
            OSLO\n"</c> or <c>"Postbox 123,\nBridgelane 123,\nWest
            Tooting,\nEast Shire ES2 W31\n"</c>.
          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.Services.LocalizedField:
      description: "LocalizedField is used to store localized information such as formatted address data, a formatted phone number, etc.\r\n<para />\r\nCarrier object for LocalizedField."
      type: object
      properties:
        Name:
          description: Name of the value field
          type: string
        Value:
          description: The field's value
          type: string
        Tooltip:
          description: The tooltip
          type: string
        Label:
          description: The label of the field
          type: string
        ValueLength:
          format: int32
          description: Database length of the value
          type: integer
        AddressType:
          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.StructuredAddress:
      description: "Address with structured fields (Address1, City, Zip) - does not vary its layout by country, unliked the formatted address.\r\n<para />\r\nCarrier object for StructuredAddress."
      type: object
      properties:
        AtypeIdx:
          description: >-
            Bit mask, combines address type (EAddressType) and owner type
            (EOwnerType)
          enum:
            - Unknown
            - ContactPostalAddress
            - ContactStreetAddress
            - PersonPrivateAddress
            - QuoteBillingAddress
            - QuoteShippingAddress
          type: string
        Address1:
          description: Address line 1
          type: string
        Address2:
          description: Address line 2
          type: string
        Address3:
          description: Address line 3
          type: string
        City:
          description: City corresponding to zip code
          type: string
        County:
          description: County (not country)
          type: string
        State:
          description: State
          type: string
        Zipcode:
          description: Zip code, alphanumeric
          type: string
        Formatted:
          description: >-
            Read-only formatted address multi-line string. e.g.: <c>"Brugata
            123,\n1234 OSLO\n"</c> or <c>"Bridgelane 123,\nWest Tooting,\nThe
            Shire ES2 W31\n"</c>.
          type: string
    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

- [NSContactAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSContactAgent.md)
- [contact](/en/api/mdo-providers/reference/contact.md)
- [Get Contact Phones](/en/api/reference/restful/agent/phonelist_agent/get-contact-phones.md)
- [Get Contact](/en/api/reference/restful/agent/contact_agent/get-contact.md)
- [Get Contact With Persons](/en/api/reference/restful/agent/contact_agent/get-contact-with-persons.md)
- [Get Contact Entity](/en/api/reference/restful/agent/contact_agent/get-contact-entity.md)