Search permittees

curl --request GET \
  --url https://app.colacloud.us/api/v1/permittees \
  --header 'X-API-Key: <api-key>'

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

fetch('https://app.colacloud.us/api/v1/permittees', 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://app.colacloud.us/api/v1/permittees",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-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://app.colacloud.us/api/v1/permittees"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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://app.colacloud.us/api/v1/permittees")

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

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

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

{
  "data": [
    {
      "permit_number": "<string>",
      "company_name": "<string>",
      "company_state": "<string>",
      "company_zip_code": "<string>",
      "permittee_type": "<string>",
      "is_active": true,
      "active_reason": "<string>",
      "colas": 123,
      "colas_approved": 123,
      "last_cola_application_date": "2023-12-25"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "pages": 123,
    "has_more": true,
    "next_cursor": "<string>"
  }
}

GET

permittees

Search permittees

curl --request GET \
  --url https://app.colacloud.us/api/v1/permittees \
  --header 'X-API-Key: <api-key>'

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

fetch('https://app.colacloud.us/api/v1/permittees', 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://app.colacloud.us/api/v1/permittees",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-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://app.colacloud.us/api/v1/permittees"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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://app.colacloud.us/api/v1/permittees")

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

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

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

{
  "data": [
    {
      "permit_number": "<string>",
      "company_name": "<string>",
      "company_state": "<string>",
      "company_zip_code": "<string>",
      "permittee_type": "<string>",
      "is_active": true,
      "active_reason": "<string>",
      "colas": 123,
      "colas_approved": 123,
      "last_cola_application_date": "2023-12-25"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "pages": 123,
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

API key passed in the X-API-Key header

Query Parameters

string

Search by company name (partial match)

state

string

Filter by state (two-letter code, case-insensitive)

permittee_type

string

Filter by permittee type (partial match, case-insensitive)

is_active

enum<string>

Filter by active permit status

Available options:

true,

false

page

integer

default:1

Page number

Required range: x >= 1

per_page

integer

default:20

Results per page (max 100)

Required range: 1 <= x <= 100

sort

enum<string>

default:colas_desc

Sort order. Defaults to most COLAs. Use relevance_desc with q when strongest text matches should rank first.

Available options:

colas_desc,

company_name_asc,

last_cola_desc,

relevance_desc

Response

Successful response

data

object[]

Show child attributes

pagination

object

Show child attributes

Getting Started

API Reference

SDKs & Tools

Guides

Data Products

Regulatory Reference (Experimental)

Trust

Search permittees

Authorizations

Query Parameters

Response