Gradient

List Companies

Retrieve a paginated list of companies with filtering options. Uses cursor-based pagination to ensure data consistency.

Endpoint

GET/api/v1/companies

Parameters

cursorstring

Cursor for pagination. Use next_cursor from previous response

limitinteger

Items per page (default: 20, max: 100)

searchstring

Search by company name or brand

industrystring

Filter by industry ID

locationstring

Filter by location

has_jobsboolean

Only show companies with active job postings

Responses

200Successful response with company listings
{
  "data": [
    {
      "id": "64a1b2c3d4e5f678901234a",
      "name": "Tech Innovators Inc",
      "slug": "tech-innovators-inc",
      "logo": "https://example.com/logo.png",
      "description": "Leading technology company specializing in AI and machine learning solutions.",
      "active_jobs_count": 12,
      "status": true,
      "created_at": "2025-01-15T10:00:00Z"
    },
    {
      "id": "64a1b2c3d4e5f678901234b",
      "name": "Digital Solutions Co",
      "slug": "digital-solutions-co",
      "logo": "https://example.com/logo2.png",
      "description": "Digital transformation and cloud computing services.",
      "active_jobs_count": 8,
      "status": true,
      "created_at": "2025-02-20T10:00:00Z"
    }
  ],
  "pagination": {
    "cursor": null,
    "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNS0wMS0xNVQxMDowMDowMFoiLCJpZCI6IjY0YTFiMmMzZDRlNWY2Nzg5MDEyMzRhIn0=",
    "has_more": true,
    "limit": 20
  },
  "meta": {
    "api_version": "v1",
    "timestamp": "2025-08-01T12:00:00Z"
  }
}
400Bad request - invalid parameters
401Unauthorized - invalid or missing API key

Code Examples

curl -X GET https://essence-api.gradientgroup.com/api/v1/companies \
  -H "Authorization: Bearer YOUR_API_KEY"

API Configuration

Your API key is stored locally and used for testing.

Try it out

Parameters