Karzoun Docs

QUERY

companies(page: Int, perPage: Int, tag: String, ids: [String], excludeIds: Boolean, searchValue: String, autoCompletion: Boolean, autoCompletionType: String, sortField: String, sortDirection: SortDirection, dateFilters: String, conformityMainType: String, conformityMainTypeId: String, conformityRelType: String, conformityIsRelated: Boolean, conformityIsSaved: Boolean): CompaniesListResponse

Arguments

page

Int

perPage

Int

tag

String

ids

[String]

excludeIds

Boolean

searchValue

String

autoCompletion

Boolean

autoCompletionType

String

sortField

String

sortDirection

SortDirection

dateFilters

String

conformityMainType

String

conformityMainTypeId

String

conformityRelType

String

conformityIsRelated

Boolean

conformityIsSaved

Boolean

Returns

CompaniesListResponse

data

[Company]

pagination

PaginationInfo!

Query

query Companies {
  companies {
    data {
      createdAt
      modifiedAt
      avatar
      size
      website
      industry
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "companies": {
      "data": [
        {
          "createdAt": "value",
          "modifiedAt": "value",
          "avatar": "string",
          "size": 1,
          "website": "string",
          "industry": "string"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

Last modified on August 8, 2026

⌘I

Query

query Companies {
  companies {
    data {
      createdAt
      modifiedAt
      avatar
      size
      website
      industry
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "companies": {
      "data": [
        {
          "createdAt": "value",
          "modifiedAt": "value",
          "avatar": "string",
          "size": 1,
          "website": "string",
          "industry": "string"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

Getting started

Guides

Try it

Queries

Mutations

Types

companies

Arguments

Returns