List business records

curl --request GET \
  --url https://api.getcurrent.ca/v1/businesses \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getcurrent.ca/v1/businesses', 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.getcurrent.ca/v1/businesses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.getcurrent.ca/v1/businesses"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.getcurrent.ca/v1/businesses")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "businesses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "name": "<string>",
      "operatingNames": [
        "<string>"
      ],
      "jurisdiction": "<string>",
      "registrationNumber": "<string>",
      "businessNumber": "<string>",
      "entityType": "<string>",
      "sourceEntityType": "<string>",
      "registryStatus": "<string>",
      "incorporationDate": "<string>",
      "incorporationYear": 123,
      "registrations": [
        {}
      ],
      "address": {
        "street": "<string>",
        "unit": "<string>",
        "city": "<string>",
        "province": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
      },
      "addresses": [
        {}
      ],
      "people": [
        {
          "name": "<string>",
          "roles": [
            "<string>"
          ],
          "email": "<string>"
        }
      ],
      "website": "<string>",
      "additionalWebsites": [
        "<string>"
      ],
      "phoneNumber": "<string>",
      "email": "<string>",
      "industry": "<string>",
      "industryCategory": "<string>",
      "naicsCode": "<string>",
      "naicsCodeName": "<string>",
      "businessDescription": "<string>",
      "originationDate": "<string>",
      "notes": "<string>",
      "sourceUrls": [
        "<string>"
      ],
      "isMonitored": true,
      "isArchived": true,
      "verificationStatus": "verified",
      "lastVerifiedAt": "2023-11-07T05:31:56Z",
      "lastVerificationJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "latestVerificationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "hasUnresolvedDiscrepancies": true,
      "lastSearchedAt": "2023-11-07T05:31:56Z",
      "lastSearchJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lastScreenedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "hasMore": true
  },
  "cursor": {
    "next": "<string>"
  }
}

Businesses

List business records

List your organization’s business records, oldest-change first. Use as a change feed for keeping your systems in sync: pass updated_since (an ISO 8601 timestamp) on the first request to fetch only records changed since your last sync, then re-request with the opaque cursor.next token returned until pagination.hasMore is false. Results are ordered by updatedAt then id ascending, and the keyset cursor carries both, so paging is deterministic and never skips records that share an updatedAt.

GET

businesses

curl --request GET \
  --url https://api.getcurrent.ca/v1/businesses \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getcurrent.ca/v1/businesses', 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.getcurrent.ca/v1/businesses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.getcurrent.ca/v1/businesses"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.getcurrent.ca/v1/businesses")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "businesses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "name": "<string>",
      "operatingNames": [
        "<string>"
      ],
      "jurisdiction": "<string>",
      "registrationNumber": "<string>",
      "businessNumber": "<string>",
      "entityType": "<string>",
      "sourceEntityType": "<string>",
      "registryStatus": "<string>",
      "incorporationDate": "<string>",
      "incorporationYear": 123,
      "registrations": [
        {}
      ],
      "address": {
        "street": "<string>",
        "unit": "<string>",
        "city": "<string>",
        "province": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
      },
      "addresses": [
        {}
      ],
      "people": [
        {
          "name": "<string>",
          "roles": [
            "<string>"
          ],
          "email": "<string>"
        }
      ],
      "website": "<string>",
      "additionalWebsites": [
        "<string>"
      ],
      "phoneNumber": "<string>",
      "email": "<string>",
      "industry": "<string>",
      "industryCategory": "<string>",
      "naicsCode": "<string>",
      "naicsCodeName": "<string>",
      "businessDescription": "<string>",
      "originationDate": "<string>",
      "notes": "<string>",
      "sourceUrls": [
        "<string>"
      ],
      "isMonitored": true,
      "isArchived": true,
      "verificationStatus": "verified",
      "lastVerifiedAt": "2023-11-07T05:31:56Z",
      "lastVerificationJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "latestVerificationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "hasUnresolvedDiscrepancies": true,
      "lastSearchedAt": "2023-11-07T05:31:56Z",
      "lastSearchJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lastScreenedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "hasMore": true
  },
  "cursor": {
    "next": "<string>"
  }
}

Authorizations

Authorization

string

header

required

API key as Bearer token: Authorization: Bearer cur_live_xxxxx

Query Parameters

limit

integer

default:50

Maximum number of results per page (1-100)

Required range: 1 <= x <= 100

cursor

string

Opaque continuation token from a prior response's cursor.next. Takes precedence over updated_since (which only seeds the first request). Persist it verbatim between runs.

updated_since

string<date-time>

Return only records with updatedAt strictly after this ISO 8601 timestamp. Used only on the first request; thereafter pass cursor.

external_id

string

Filter to the single record matching this customer external id

archived

boolean

Filter by archived status

monitored

boolean

Filter by monitoring status

Response

Business records list

businesses

object[]

Show child attributes

pagination

object

Show child attributes

cursor

object

Show child attributes

Overview

Guides

Concepts

API Reference

Changelog

Releases

List business records

Authorizations

Query Parameters

Response