SOsoldo
Contacts

Search Contacts

Changed on

Endpoint to search Contacts using filtering parameters.

get/business/v2/contacts

Request

Query parameters

statusesContactStatus[]

The status to search Contacts by. Multiple values are allowed. If omitted, Contacts in both CREATED and SUGGESTED status are returned.

namestring[]

The name to search Contacts by. Multiple values are allowed.

[
  "John Doe"
]
typeContactType[]

The type to search Contacts by. Multiple values are allowed.

countriesISO3166Country[]

The ISO 3166-1 alpha-3 code of the country to search Contacts by. Multiple values are allowed.

userstring[]

The ID of the User the Contact is assigned to, to search Contacts by (only Contacts of type EMPLOYEE are assigned to a User). Multiple values are allowed.

[
  "XMPL1234-000001"
]
pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3
sinteger

It indicates the number of items per page.

Example:25
d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC
propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The returned result is a list of Contacts.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "name": "John Doe",
      "user_id": "XMPL1234-000001",
      "account_info": [
        {
          "identification": "GB00ABCD00000123456789"
        }
      ],
      "bic": "UNCRITMMXXX",
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update_time": "2017-06-01T12:48:40Z",
      "validation": {
        "field": "name",
        "current_value": "JAMES ADAN",
        "suggested_value": "JAMES ADAM"
      }
    }
  ]
}

Changes

  • 23fc5d07b367Revision changes
    • info

      added the optional property // to the response with the status

  • 7be21448a2b3Revision changes
    • warning

      added the new QZZ enum value to the // response property for the response status

    • info

      added the enum value QZZ to the property items/ of the query request parameter countries

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status