List companies

List all companies. Please note that you’ll need to provide a ‘take’ and ‘skip’ parameter to paginate through the results. If no parameters are provided, it will be default take the first 10 results. Authentication is required.

GET /companies

List companies

cURL

curl --request GET \
  --url https://productlane.com/api/v2/companies \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://productlane.com/api/v2/companies"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://productlane.com/api/v2/companies', 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://productlane.com/api/v2/companies",
  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://productlane.com/api/v2/companies"

	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))

}

HttpResponse<String> response = Unirest.get("https://productlane.com/api/v2/companies")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://productlane.com/api/v2/companies")

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

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "logo_url": "<string>",
      "domains": [
        "<string>"
      ],
      "size": 123,
      "revenue": 123,
      "status_id": "<string>",
      "status_name": "<string>",
      "tier_id": "<string>",
      "tier_name": "<string>",
      "owner": {
        "id": "<string>",
        "name": "<string>",
        "avatar_url": "<string>"
      },
      "external_ids": [
        "<string>"
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "page": {
    "cursor": "<string>",
    "has_more": true,
    "limit": 123
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer

Required range: 1 <= x <= 200

cursor · string

external_id · string

Matches an entry in the company's external_ids array.

domain · string

Matches an entry in the company's domains array.

name_contains · string

Required string length: 1 - 255

status_id · string

tier_id · string

size_gte · integer

Required range: x >= 0

size_lte · integer

Required range: x >= 0

revenue_gte · integer

Required range: x >= 0

revenue_lte · integer

Required range: x >= 0

created_after · string<date-time>

created_before · string<date-time>

updated_after · string<date-time>

updated_before · string<date-time>

Response

200

application/json

Successful response

data · object[] · required

Show child attributes

page · object · required

Show child attributes