List Companies

Retrieve a paginated list of companies

GET /api/v1/companies

cURL

curl -X GET "https://api.orwel.io/api/v1/companies?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": [
    {
      "id": "company-uuid",
      "name": "Acme Corp",
      "domain": "acme.com",
      "description": "Leading provider of widgets",
      "employees": "100-500",
      "main_industry": "Manufacturing",
      "created_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 50
  }
}

Query Parameters

limit · integer · default: "50"

Maximum number of results to return (max: 100)

offset · integer · default: "0"

Number of results to skip for pagination

name · string

Filter companies by name (partial match)

domain · string

Filter companies by domain (exact match)

Response

data · array

Array of company objects

Show Company Object

id · string

Unique identifier for the company

name · string

Company name

domain · string

Company domain

description · string

Description

employees · string

Number of employees

main_industry · string

Main industry

created_at · string

ISO 8601 timestamp of creation

pagination · object

Pagination information

cURL

curl -X GET "https://api.orwel.io/api/v1/companies?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": [
    {
      "id": "company-uuid",
      "name": "Acme Corp",
      "domain": "acme.com",
      "description": "Leading provider of widgets",
      "employees": "100-500",
      "main_industry": "Manufacturing",
      "created_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 50
  }
}