POST Agents/Contact/GetContactList

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Contact/GetContactList

Gets an array of Contact objects.

Query String Parameters

Parameter Name Type Description
$select string 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. 
POST /api/v1/Agents/Contact/GetContactList?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: contactIds

The primary keys.

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
ContactId int32 Primary key
Name string Contact name
OrgNr string VAT number or similar
Department string Department
URL string The internet address to this contact
City string City corresponding to zip code
DirectPhone string The contacts phone
AssociateId int32 Our contact
CountryId int32 Country
EmailAddress string The contact email address
Kananame string Contact kana name, used in Japanese versions only
EmailAddressName string Visible field
URLName string Visible field
AssociateFullName string The associate's culture formatted fullname (firstname, middleName and lastname)
BusinessName string The business list item name
CategoryName string The category list item name
CountryName string Name of country in installed language
Address Address Contact address as a list of LocalizedFieldList objects. Used to store localized information such as formatted address data. Suitable for passing to an address control for display.
FormattedAddress string The contact's address, formatted with linebreaks and spaces into a single string.
FullName string
IsOwnerContact bool Is the contact an owner contact. This means that all persons on this contact can on only be internal users and not external users.
ActiveErpLinks int32 The number of active erp links
Number1 string Alphanumeric user field
Number2 string Alphanumeric user field
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Contact/GetContactList
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "ContactId": 65,
    "Name": "Mueller, Hilll and Keeling",
    "OrgNr": "847009",
    "Department": "",
    "URL": "http://www.example.com/",
    "City": "temporibus",
    "DirectPhone": "(287)188-2017",
    "AssociateId": 692,
    "CountryId": 963,
    "EmailAddress": "reece@hane.biz",
    "Kananame": "sunt",
    "EmailAddressName": "larue_satterfield@rowe.name",
    "URLName": "http://www.example.com/",
    "AssociateFullName": "Mr. Alba Arnaldo Steuber Sr.",
    "BusinessName": "Information Technology",
    "CategoryName": "VIP Customer",
    "CountryName": "Sokovia",
    "Address": null,
    "FormattedAddress": "molestias",
    "FullName": "Sid Cormier",
    "IsOwnerContact": false,
    "ActiveErpLinks": 748,
    "Number1": "1170665",
    "Number2": "1129621",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 42
      }
    }
  }
]