partnersCount

Requires at least one of the permissions customers:customer:list, customers:customer:read, payments:collection:create, payments:invoice:create, products:discount:update, purchase:debit_note:create, purchase:grn:create, purchase:payment:create, purchase:purchase_invoice:create, purchase:purchase_order:create, sales:credit_note:create, sales:quote:create, sales:sales_order:create, suppliers:supplier:list or suppliers:supplier:read.

Returns how many partners match a filter, using the same filter and visibility as partners.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PartnersCount {
  partnersCount
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PartnersCount {\n  partnersCount\n}"
}
EOF

Response:

{
  "data": {
    "partnersCount": 0
  }
}

partnersCount(
  filter: PartnerFilterInput
): Int!

Arguments

partnersCount.filter ● PartnerFilterInput input

Narrows the partners counted.

Type

Int scalar

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.