ACacculynx
contacts

Get Contacts

Changed on

Use this endpoint to get a listing of Contacts. Supported includes: emailAddress, phoneNumber.

get/contacts

Request

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

Query parameters

pageSizeinteger

How many items to be returned at a time.

pageStartIndexinteger

The index of the page to return

includesstring

A comma-separated list of related resources to expand inline in the response. Valid values vary by endpoint and are documented in each operation description.

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