Karzoun Docs

QUERY

customers(page: Int, perPage: Int, segmentV2Id: String, type: String, tag: String, ids: [String], excludeIds: Boolean, searchValue: String, autoCompletion: Boolean, autoCompletionType: String, integration: String, form: String, startDate: String, endDate: String, leadStatus: String, sortField: String, sortDirection: SortDirection, sex: Int, birthDate: Date, dateFilters: String, emailValidationStatus: String, conformityMainType: String, conformityMainTypeId: String, conformityRelType: String, conformityIsRelated: Boolean, conformityIsSaved: Boolean): CustomersListResponse

Arguments

page

Int

perPage

Int

segmentV2Id

String

type

String

tag

String

ids

[String]

excludeIds

Boolean

searchValue

String

autoCompletion

Boolean

autoCompletionType

String

integration

String

form

String

startDate

String

endDate

String

leadStatus

String

sortField

String

sortDirection

SortDirection

sex

Int

birthDate

Date

dateFilters

String

emailValidationStatus

String

conformityMainType

String

conformityMainTypeId

String

conformityRelType

String

conformityIsRelated

Boolean

conformityIsSaved

Boolean

Returns

CustomersListResponse

data

[Customer]

pagination

PaginationInfo!

Query

query Customers {
  customers {
    data {
      state
      createdAt
      modifiedAt
      avatar
      integrationId
      firstName
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "customers": {
      "data": [
        {
          "state": "string",
          "createdAt": "value",
          "modifiedAt": "value",
          "avatar": "string",
          "integrationId": "string",
          "firstName": "string"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

Last modified on August 8, 2026

⌘I

Query

query Customers {
  customers {
    data {
      state
      createdAt
      modifiedAt
      avatar
      integrationId
      firstName
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "customers": {
      "data": [
        {
          "state": "string",
          "createdAt": "value",
          "modifiedAt": "value",
          "avatar": "string",
          "integrationId": "string",
          "firstName": "string"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

Getting started

Guides

Try it

Queries

Mutations

Types

customers

Arguments

Returns