List Companies

curl --request GET \
  --url https://api.example.com/companies

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/companies",
  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/companies"

	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/companies")

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

{
  "success": true,
  "data": {
    "data.items": [
      {
        "data.items[].id": "<string>",
        "data.items[].name": "<string>",
        "data.items[].slug": "<string>",
        "data.items[].industry": "<string>",
        "data.items[].country": "<string>",
        "data.items[].timezone": "<string>",
        "data.items[].currency": "<string>",
        "data.items[].registration_number": "<string>",
        "data.items[].tax_id": "<string>",
        "data.items[].address": "<string>",
        "data.items[].phone": "<string>",
        "data.items[].logo_url": "<string>",
        "data.items[].status": "<string>",
        "data.items[].settings": {},
        "data.items[].created_at": "<string>",
        "data.items[].updated_at": "<string>"
      }
    ],
    "data.total": 123,
    "data.page": 123,
    "data.page_size": 123,
    "data.total_pages": 123
  }
}

GET

companies

List Companies

curl --request GET \
  --url https://api.example.com/companies

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/companies",
  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/companies"

	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/companies")

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

{
  "success": true,
  "data": {
    "data.items": [
      {
        "data.items[].id": "<string>",
        "data.items[].name": "<string>",
        "data.items[].slug": "<string>",
        "data.items[].industry": "<string>",
        "data.items[].country": "<string>",
        "data.items[].timezone": "<string>",
        "data.items[].currency": "<string>",
        "data.items[].registration_number": "<string>",
        "data.items[].tax_id": "<string>",
        "data.items[].address": "<string>",
        "data.items[].phone": "<string>",
        "data.items[].logo_url": "<string>",
        "data.items[].status": "<string>",
        "data.items[].settings": {},
        "data.items[].created_at": "<string>",
        "data.items[].updated_at": "<string>"
      }
    ],
    "data.total": 123,
    "data.page": 123,
    "data.page_size": 123,
    "data.total_pages": 123
  }
}

Retrieve a paginated list of companies with optional filtering by status and search.

Query Parameters

integer

default:"1"

Page number for pagination

integer

default:"10"

Number of items per page

string

Filter by company status. One of: active, suspended, inactive

string

Search companies by name or slug

Response

boolean

Indicates if the request was successful

object

Paginated company results

array

Array of company objects

string

Company UUID

string

Company name

string

Company slug identifier

string

Industry sector

string

Country location

string

Timezone identifier

string

Currency code

string

Registration number

string

Tax identification

string

Physical address

string

Contact phone

string

Logo URL

string

Company status

object

Company settings (JSON)

string

Creation timestamp (ISO 8601)

string

Last update timestamp (ISO 8601)

integer

Total number of companies matching the criteria

integer

Current page number

integer

Items per page

integer

Total number of pages

Request Examples

Basic
With Pagination
Filter by Status
Search
Combined Filters

cURL

curl -X GET https://api.companyflow.com/companies \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

cURL

curl -X GET "https://api.companyflow.com/companies?page=2&page_size=20" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

cURL

curl -X GET "https://api.companyflow.com/companies?status=active" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

cURL

curl -X GET "https://api.companyflow.com/companies?search=acme" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

cURL

curl -X GET "https://api.companyflow.com/companies?page=1&page_size=10&status=active&search=tech" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response Example

200 OK

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Acme Corporation",
        "slug": "acme-corp",
        "industry": "Technology",
        "country": "United States",
        "timezone": "America/New_York",
        "currency": "USD",
        "registration_number": "123456789",
        "tax_id": "98-7654321",
        "address": "123 Main St, New York, NY 10001",
        "phone": "+1-555-0100",
        "logo_url": "",
        "status": "active",
        "settings": null,
        "created_at": "2026-03-03T10:00:00Z",
        "updated_at": "2026-03-03T10:00:00Z"
      },
      {
        "id": "223e4567-e89b-12d3-a456-426614174001",
        "name": "TechStart Inc",
        "slug": "techstart",
        "industry": "Software",
        "country": "Canada",
        "timezone": "America/Toronto",
        "currency": "CAD",
        "registration_number": "987654321",
        "tax_id": "12-3456789",
        "address": "456 Tech Ave, Toronto, ON M5H 2N2",
        "phone": "+1-416-555-0200",
        "logo_url": "https://example.com/logo.png",
        "status": "active",
        "settings": null,
        "created_at": "2026-03-02T15:30:00Z",
        "updated_at": "2026-03-02T15:30:00Z"
      }
    ],
    "total": 42,
    "page": 1,
    "page_size": 10,
    "total_pages": 5
  }
}

400 Bad Request

{
  "success": false,
  "message": "invalid page"
}

500 Internal Server Error

{
  "success": false,
  "message": "internal server error"
}

Error Responses

Status Code	Description
400	Invalid page or page_size parameter
500	Internal server error

Authentication

Companies

Employees

Departments

Designations

Levels

Roles & Permissions

Leave Types

Leave Requests

Leave Balances

Memos

Approvals

List Companies

Query Parameters

Response

Request Examples

Response Example

Error Responses

​Query Parameters

​Response

​Request Examples

​Response Example

​Error Responses

Query Parameters

Response

Request Examples

Response Example

Error Responses