List contacts

GET /v4/core/companies/{companyId}/contacts

List contacts

cURL

curl --request GET \
  --url https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts \
  --header 'api_key: <api-key>'

import requests

url = "https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts")
  .header("api_key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "data": [
      {
        "rootfi_id": 123,
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "platform_id": "<string>",
        "name": "<string>",
        "contact_name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "tax_number": "<string>",
        "registration_number": "<string>",
        "website": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "addresses": [
          {
            "rootfi_id": 123,
            "rootfi_created_at": "2023-11-07T05:31:56Z",
            "rootfi_updated_at": "2023-11-07T05:31:56Z",
            "platform_id": "<string>",
            "parent_id": "<string>",
            "street": "<string>",
            "street2": "<string>",
            "locality": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postal_code": "<string>",
            "country": "<string>"
          }
        ],
        "phone_numbers": [
          {
            "rootfi_id": 123,
            "rootfi_created_at": "2023-11-07T05:31:56Z",
            "rootfi_updated_at": "2023-11-07T05:31:56Z",
            "platform_id": "<string>",
            "parent_id": "<string>",
            "number": "<string>"
          }
        ],
        "external_links": [
          {
            "rootfi_id": 123,
            "rootfi_created_at": "2023-11-07T05:31:56Z",
            "rootfi_updated_at": "2023-11-07T05:31:56Z",
            "platform_id": "<string>",
            "parent_id": "<string>",
            "link": "<string>"
          }
        ]
      }
    ],
    "total_count": 123,
    "next": "<string>",
    "prev": "<string>"
  },
  "request_id": "<string>"
}

Authorizations

api_key · string · header · required

Your Commenda Integrations API key, sent in the api_key header.

Path Parameters

companyId · integer · required

Commenda company id.

Query Parameters

limit · integer · default: 20

Max records to return.

Required range: x <= 100

next · string

Cursor for the next page (from a previous response).

prev · string

Cursor for the previous page.

include_deleted_records · boolean

Include soft-deleted records.

return_count · boolean

Include the total match count in the response.

expand · string

Comma-separated related resources to expand: addresses, phone_numbers, external_links.

type[eq] · enum<string>

Exact match on type.

Available options: CUSTOMER, VENDOR, BOTH, UNKNOWN

type[in] · string

Comma-separated type values (OR match).

status[eq] · enum<string>

Exact match on status.

Available options: ACTIVE, INACTIVE, SUSPENDED, ARCHIVED, UNKNOWN

status[in] · string

Comma-separated status values (OR match).

name[eq] · string

Exact match on name.

name[in] · string

Comma-separated name values (OR match).

email[eq] · string

Exact match on email.

email[in] · string

Comma-separated email values (OR match).

phone[eq] · string

Exact match on phone.

phone[in] · string

Comma-separated phone values (OR match).

rootfi_integration_type[eq] · string

Exact match on rootfi_integration_type.

rootfi_integration_type[in] · string

Comma-separated rootfi_integration_type values (OR match).

rootfi_updated_at[eq] · string

Exact match on rootfi_updated_at.

rootfi_updated_at[in] · string

Comma-separated rootfi_updated_at values (OR match).

rootfi_updated_at[gte] · string

rootfi_updated_at greater-than-or-equal.

rootfi_updated_at[lte] · string

rootfi_updated_at less-than-or-equal.

created_at[eq] · string

Exact match on created_at.

created_at[in] · string

Comma-separated created_at values (OR match).

created_at[gte] · string

created_at greater-than-or-equal.

created_at[lte] · string

created_at less-than-or-equal.

updated_at[eq] · string

Exact match on updated_at.

updated_at[in] · string

Comma-separated updated_at values (OR match).

updated_at[gte] · string

updated_at greater-than-or-equal.

updated_at[lte] · string

updated_at less-than-or-equal.

Response

200 - application/json

A paginated list of contacts.

data · object · required

Show child attributes

request_id · string · required