Contacts

Manage contact information for individuals associated with companies. Contacts can have various roles such as primary contact, billing contact, or operations contact.

Quick Reference

Method	Endpoint	Description
GET	/api/contacts/{id}	Get contact by ID
GET	/api/contacts/user
GET	/api/contacts/{contactId}/editdetails
PUT	/api/contacts/{contactId}/editdetails
POST	/api/contacts/editdetails
POST	/api/contacts/search
POST	/api/contacts/v2/search
POST	/api/contacts/customers
GET	/api/contacts/{contactId}/primarydetails

GET /api/contacts/{id}

Get contact by ID

Retrieves information about a specific contact.

Parameters:

Path Parameters:

• id (integer, path) (required): No description available

Response Type:

Contact

See the model documentation for detailed field descriptions.

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/contacts/{id}"
,
    id=789e0123-e89b-12d3-a456-426614174002

)

# Process the response
print(response)

Sample Response:

{
  "id": 266841,
  "contactDisplayId": "1",
  "fullName": "John Doe",
  "firstName": "John",
  "lastName": "Doe",
  "contactTypeId": 1,
  "companyId": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "isActive": true,
  "primaryEmail": "john.doe@example.com",
  "primaryPhone": "555-123-4567"
}

---

GET /api/contacts/user

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/contacts/user"

)

# Process the response
print(response)

Sample Response:

{
  "status": "success",
  "data": {}
}

---

GET /api/contacts/{contactId}/editdetails

Parameters:

Path Parameters:

• contactId (integer, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/contacts/{contactId}/editdetails"
,
    contactId=456e7890-e89b-12d3-a456-426614174001

)

# Process the response
print(response)

Sample Response:

[]

---

PUT /api/contacts/{contactId}/editdetails

Parameters:

Path Parameters:

• contactId (integer, path) (required): No description available

Query Parameters:

• franchiseeId (string, query): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.put(
    "/api/contacts/{contactId}/editdetails"
,
    contactId="456e7890-e89b-12d3-a456-426614174001"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{}

---

POST /api/contacts/editdetails

Parameters:

Query Parameters:

• franchiseeId (string, query): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/contacts/editdetails"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{}

---

POST /api/contacts/search

Parameters:

Query Parameters:

• companyId (string, query): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/contacts/search"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

[]

---

POST /api/contacts/v2/search

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/contacts/v2/search"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

[]

---

POST /api/contacts/customers

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/contacts/customers"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

GET /api/contacts/{contactId}/primarydetails

Parameters:

Path Parameters:

• contactId (integer, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/contacts/{contactId}/primarydetails"
,
    contactId=456e7890-e89b-12d3-a456-426614174001

)

# Process the response
print(response)

Sample Response:

[]