Skip to main content
get/contacts/count

Count contacts

LLM
View as Markdown
Open llms.txt

Returns the tenant's contact count for a navigation/dashboard badge. This is independent of any list filters; the archived query parameter selects which bucket to count.

Authorization

Scheme

  • bearerAuth

Required scopes

  • contact:list

Allowed roles

  • owner
  • admin
  • agent

Count contacts in the caller's contact scope.

Parameters

  • Name
    archived
    Type
    query boolean
    Description
    Omit or pass false for non-archived count; pass true for archived-bucket count.

Responses

  • 200

    Contact count

    • application/json ContactsCountResponse
  • default

    Error

    • application/json ProblemDetails