List accounts - Kiflo

GET

/

v3

/

account-mapping

/

accounts

List accounts

curl --request GET \
  --url https://api.example.com/v3/account-mapping/accounts

const options = {method: 'GET'};

fetch('https://api.example.com/v3/account-mapping/accounts', 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.example.com/v3/account-mapping/accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/v3/account-mapping/accounts"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/account-mapping/accounts")

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

request = Net::HTTP::Get.new(url)

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

{
  "items": [
    {
      "id": 1,
      "externalId": "0015g00000ABCDEFGHI",
      "name": "Acme Corporation",
      "type": "Customer",
      "country": "United States",
      "websiteUrl": "https://www.acme.com",
      "ownerName": "Jane Doe",
      "ownerEmail": "jane.doe@acme.com",
      "dataSourceId": 1,
      "dataSourceName": "Salesforce export Q1",
      "dataSourceType": "Csv",
      "importedDate": "2026-04-22T10:06:00Z",
      "prospectOverlapsCount": 2,
      "opportunityOverlapsCount": 1,
      "customerOverlapsCount": 0
    }
  ],
  "paginationSkipCount": 0,
  "totalCount": 1
}

Query Parameters

offset

integer<int32>

The cursor used in pagination. This is the index of the first account to be returned.

limit

integer<int32>

The maximum number of accounts to be returned. The default is 20.

sort_by

string

The property used to sort the accounts by. The default is Name.

order_by

string

The sorting direction for the returned accounts. Accepted values: ASC, DESC. The default is ASC.

type

enum<string>

Filters accounts on their type.

Available options:

Unknown,

Prospect,

Opportunity,

Customer

data_source_id

integer<int32>

Filters accounts on the data source they were imported from.

external_id

string

Filters accounts on their external ID.

has_prospect_overlaps

boolean

Filters accounts on whether they overlap with at least one prospect account. When true, returns only accounts that overlap with a prospect account; when false, returns only accounts that do not. When omitted, no filter is applied.

has_customer_overlaps

boolean

Filters accounts on whether they overlap with at least one customer account. When true, returns only accounts that overlap with a customer account; when false, returns only accounts that do not. When omitted, no filter is applied.

has_opportunity_overlaps

boolean

Filters accounts on whether they overlap with at least one opportunity account. When true, returns only accounts that overlap with an opportunity account; when false, returns only accounts that do not. When omitted, no filter is applied.

Response

Accounts returned

items

object[] | null

Show child attributes

paginationSkipCount

integer<int32>

totalCount

integer<int32>

Gets or sets the total number of items that could be returned by this command (without pagination).

List accounts

curl --request GET \
  --url https://api.example.com/v3/account-mapping/accounts

const options = {method: 'GET'};

fetch('https://api.example.com/v3/account-mapping/accounts', 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.example.com/v3/account-mapping/accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/v3/account-mapping/accounts"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/account-mapping/accounts")

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

request = Net::HTTP::Get.new(url)

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

{
  "items": [
    {
      "id": 1,
      "externalId": "0015g00000ABCDEFGHI",
      "name": "Acme Corporation",
      "type": "Customer",
      "country": "United States",
      "websiteUrl": "https://www.acme.com",
      "ownerName": "Jane Doe",
      "ownerEmail": "jane.doe@acme.com",
      "dataSourceId": 1,
      "dataSourceName": "Salesforce export Q1",
      "dataSourceType": "Csv",
      "importedDate": "2026-04-22T10:06:00Z",
      "prospectOverlapsCount": 2,
      "opportunityOverlapsCount": 1,
      "customerOverlapsCount": 0
    }
  ],
  "paginationSkipCount": 0,
  "totalCount": 1
}