Versions Compared

Old Version 1

changes.mady.by.user Kurt Wagner

Saved on

compared with

New Version Current

changes.mady.by.user Kurt Wagner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

_pageunsigned intThe page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limitunsigned intThe maximum number of resources to return. Default is 10 and maximum is 50.
_offsetunsigned intThe position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page.
_fieldspartial stringAllows you to specify optional fields and linked objects to include in the response.
_filterspartial stringAllows you to filter contacts. For more information on available filters, please see the filter action.
_searchstringAllows you to search for a contact with a given string. This will look against first namefax, surnamephone, mobile and email.

Filters

For a list of filters, please see the contacts endpoint page, found here.

Handling the response

Returns an array of contact objects. Please see GET affiliation information.