ACacculynx
contacts

Search Contacts

Changed on

Use this endpoint to get a list of contacts matching the given search criteria. Contacts are returned if they include a given first name, last name, company name, and contact type. it will filter by range of dates, using the CreationDate of the contact. The size of the return is controlled with the pageSize query parameter which defaults to 25 and must be > 0 and <= 25. Set pageIndex > 0 to access contacts past the first page when more than pageSize contacts meet the search criteria. Sort criteria, startDate and endDate are required. The search returns includes like phone numbers, email addresses and location address.

post/contacts/search

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/contacts/search
  • Auth
    HTTP bearer

Query parameters

pageSizeinteger

How many items to be returned at a time.

pageStartIndexinteger

The index of the page to return

Request body

contactTypesstring[]
searchTermstring

It could be the first name, last name, company name of the contact.

startDatestring date-time required

An ISO 8601 string of the startDate to search. It will search by CreationDate. https://en.wikipedia.org/wiki/ISO_8601

endDatestring date-time required

An ISO 8601 string of the endDate to search It will search by CreationDate. https://en.wikipedia.org/wiki/ISO_8601

Example request

{
  "contactTypes": [
    "Customer"
  ],
  "searchTerm": "John Smith",
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-06-30T23:59:59Z"
}

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "id": "61370abe-3534-4ba8-b2f2-2ff56cdd5e02",
      "_link": "https://api.acculynx.com/v2/contacts/61370abe-3534-4ba8-b2f2-2ff56cdd5e02",
      "firstName": "John",
      "lastName": "Smith",
      "salutation": "Mr.",
      "companyName": "Acme Roofing Inc.",
      "phoneNumbers": [
        {
          "id": "b2830ef6-c5ff-44ca-a3b9-aa767f50a04b",
          "_link": "https://api.acculynx.com/api/v2/contacts/7f008cca-9789-44c3-afdf-7ec2e005c267/phone-numbers/b2830ef6-c5ff-44ca-a3b9-aa767f50a04b"
        }
      ],
      "emailAddresses": [
        {
          "id": "40ac2713-13eb-4c69-8780-eee57fc71cba",
          "_link": "https://api.acculynx.com/api/v2/contacts/d0b29a1b-6023-4a27-b028-25e85796c40b/email-addresses/40ac2713-13eb-4c69-8780-eee57fc71cba"
        }
      ],
      "mailingAddress": {
        "street1": "123 Main St.",
        "street2": "Apt 2",
        "city": "Peoria",
        "state": {
          "id": 43,
          "name": "Texas",
          "abbreviation": "TX",
          "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1/states/43"
        },
        "zipCode": "61603",
        "country": {
          "id": 1,
          "name": "United States",
          "abbreviation": "US",
          "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1"
        }
      },
      "billingAddress": {
        "street1": "123 Main St.",
        "street2": "Apt 2",
        "city": "Peoria",
        "state": {
          "id": 43,
          "name": "Texas",
          "abbreviation": "TX",
          "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1/states/43"
        },
        "zipCode": "61603",
        "country": {
          "id": 1,
          "name": "United States",
          "abbreviation": "US",
          "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1"
        }
      },
      "createdDate": "2024-03-15T10:30:00Z",
      "modifiedDate": "2025-06-20T14:00:00Z"
    }
  ]
}

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

      the /////// response's property format changed from uri to no format for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the optional property to the response with the status