---
title: "Search call entries"
url: "https://developers.zinnia.com/apis/orion-api/versions/716288b7-e96e-41a7-abc5-63925410717a/operations/search-call-entries"
---

> Full API specification: https://developers.zinnia.com/apis/orion-api/versions/716288b7-e96e-41a7-abc5-63925410717a.md

# Search call entries

`GET` `/callcenter/v1/CallEntry`

Operation ID: `search-call-entries`

Searches call records and returns a paginated collection of complete `CallEntry` objects. Filters can narrow the results by company, contract, caller, call type, transaction type, or date. Use `X-Client-Code` to search within one company. The `clientCode` query parameter remains available for backward compatibility and takes precedence if both values are supplied. If neither is supplied, Orion searches across every company the caller is authorized to read.

## Query parameters

- `clientCode` (string, optional) - Selects one company. Takes precedence over `X-Client-Code` if both are supplied. If neither is supplied, search includes every company the caller is authorized to read; get-by-ID requires at least one tenant selector.
- `Contract` (string, optional) - Matches a contract number associated with the call entry. Also searches the entry's stored contract list and, when that list is absent, its reference value.
- `CallerTypeID` (integer, int32, optional) - Matches the call entry's caller-type ID.
- `CallerType` (string, optional) - Matches the call entry's caller-type name.
- `CallerName` (string, optional) - Matches the caller name exactly unless `usePartialCallerNameMatch` is `true`.
- `UsePartialCallerNameMatch` (boolean, optional) - When `true`, `callerName` may occur anywhere within the stored caller name. When `false`, the names must match exactly. Defaults to `false`.
- `CallTypeID` (integer, int32, optional) - Matches a call-type ID assigned directly to the call entry or to one of its contracts.
- `CallType` (string, optional) - Matches a call-type name assigned directly to the call entry or to one of its contracts.
- `TransactionTypeID` (integer, int32, optional) - Matches the call entry's transaction-type ID.
- `TransactionType` (string, optional) - Matches the call entry's transaction-type name.
- `CreatedStartDate` (string, date-time, optional) - Includes entries created at or after this date and time.
- `CreatedEndDate` (string, date-time, optional) - Includes entries created at or before this date and time.
- `LastUpdatedStartDate` (string, date-time, optional) - Includes entries last updated at or after this date and time.
- `LastUpdatedEndDate` (string, date-time, optional) - Includes entries last updated at or before this date and time.
- `Offset` (integer, int32, optional) - Number of results to skip. Defaults to `0`; negative values are treated as `0`.
- `Limit` (integer, int32, optional) - Maximum number of results to return. Defaults to `50`; values above `500` are limited to `500`, and non-positive values use the default.

## Header parameters

- `X-Client-Code` (string, optional) - Preferred tenant selector for new consumers. Optional only for legacy GET compatibility. If query clientCode is also supplied and conflicts after normalization, the query value wins and the conflict is logged.

## Responses

- `200` - OK
- `400` - Bad Request. Missing/blank/unknown tenant, invalid correlation ID, missing conditional M2M userName, invalid fields, unknown/inactive lookup names, or contract classification/duplication errors.
- `401` - Unauthorized. Bearer token is missing, malformed, or fails configured authentication validation.
- `403` - Forbidden. Token lacks partyId, tenant FGA read/write authorization, or contains a present but blank/malformed configured username claim on a write.
- `503` - Service Unavailable (503). FGA returned an unavailable/unusable result, or the selected tenant has duplicate active lookup names and Orion will not choose an arbitrary ID.

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: Orion Call Center API
  version: v1
servers:
  - url: https://qa.api.zinnia.io
paths:
  /callcenter/v1/CallEntry:
    get:
      tags:
        - Call Entries
      summary: Search call entries
      description: >-
        Searches call records and returns a paginated collection of complete
        `CallEntry` objects. Filters can narrow the results by company,
        contract, caller, call type, transaction type, or date.


        Use `X-Client-Code` to search within one company. The `clientCode` query
        parameter remains available for backward compatibility and takes
        precedence if both values are supplied. If neither is supplied, Orion
        searches across every company the caller is authorized to read.
      operationId: search-call-entries
      parameters:
        - name: clientCode
          in: query
          description: Selects one company. Takes precedence over `X-Client-Code` if both
            are supplied. If neither is supplied, search includes every company
            the caller is authorized to read; get-by-ID requires at least one
            tenant selector.
          schema:
            type: string
          example: ABCD
        - name: Contract
          in: query
          description: Matches a contract number associated with the call entry. Also
            searches the entry's stored contract list and, when that list is
            absent, its reference value.
          schema:
            maxLength: 200
            minLength: 1
            pattern: ^[A-Za-z0-9,-]+$
            type: string
          example: C-10001
        - name: CallerTypeID
          in: query
          description: Matches the call entry's caller-type ID.
          schema:
            type: integer
            format: int32
        - name: CallerType
          in: query
          description: Matches the call entry's caller-type name.
          schema:
            maxLength: 50
            minLength: 1
            pattern: ^[A-Za-z0-9 &'/-]+$
            type: string
          example: Owner
        - name: CallerName
          in: query
          description: Matches the caller name exactly unless `usePartialCallerNameMatch`
            is `true`.
          schema:
            maxLength: 500
            minLength: 1
            pattern: ^[A-Za-z ,.'-]+$
            type: string
          example: Jane
        - name: UsePartialCallerNameMatch
          in: query
          description: When `true`, `callerName` may occur anywhere within the stored
            caller name. When `false`, the names must match exactly. Defaults to
            `false`.
          schema:
            type: boolean
        - name: CallTypeID
          in: query
          description: Matches a call-type ID assigned directly to the call entry or to
            one of its contracts.
          schema:
            type: integer
            format: int32
        - name: CallType
          in: query
          description: Matches a call-type name assigned directly to the call entry or to
            one of its contracts.
          schema:
            maxLength: 50
            minLength: 1
            pattern: ^[A-Za-z0-9 &'/-]+$
            type: string
          example: Billing
        - name: TransactionTypeID
          in: query
          description: Matches the call entry's transaction-type ID.
          schema:
            type: integer
            format: int32
        - name: TransactionType
          in: query
          description: Matches the call entry's transaction-type name.
          schema:
            maxLength: 50
            minLength: 1
            pattern: ^[A-Za-z0-9 &'/-]+$
            type: string
          example: Payment
        - name: CreatedStartDate
          in: query
          description: Includes entries created at or after this date and time.
          schema:
            type: string
            format: date-time
        - name: CreatedEndDate
          in: query
          description: Includes entries created at or before this date and time.
          schema:
            type: string
            format: date-time
        - name: LastUpdatedStartDate
          in: query
          description: Includes entries last updated at or after this date and time.
          schema:
            type: string
            format: date-time
        - name: LastUpdatedEndDate
          in: query
          description: Includes entries last updated at or before this date and time.
          schema:
            type: string
            format: date-time
        - name: Offset
          in: query
          description: Number of results to skip. Defaults to `0`; negative values are
            treated as `0`.
          schema:
            type: integer
            format: int32
          example: 0
        - name: Limit
          in: query
          description: Maximum number of results to return. Defaults to `50`; values above
            `500` are limited to `500`, and non-positive values use the default.
          schema:
            type: integer
            format: int32
          example: 50
        - name: X-Client-Code
          in: header
          description: Preferred tenant selector for new consumers. Optional only for
            legacy GET compatibility. If query clientCode is also supplied and
            conflicts after normalization, the query value wins and the conflict
            is logged.
          schema:
            maxLength: 4
            minLength: 3
            pattern: ^[A-Za-z]{3,4}$
            type: string
          example: ABCD
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/CallEntryIEnumerablePagedResponse"
            application/json:
              schema:
                $ref: "#/components/schemas/CallEntryIEnumerablePagedResponse"
            text/json:
              schema:
                $ref: "#/components/schemas/CallEntryIEnumerablePagedResponse"
        "400":
          description: Bad Request. Missing/blank/unknown tenant, invalid correlation ID,
            missing conditional M2M userName, invalid fields, unknown/inactive
            lookup names, or contract classification/duplication errors.
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/Response"
            application/json:
              schema:
                $ref: "#/components/schemas/Response"
            text/json:
              schema:
                $ref: "#/components/schemas/Response"
        "401":
          description: Unauthorized. Bearer token is missing, malformed, or fails
            configured authentication validation.
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/Response"
            application/json:
              schema:
                $ref: "#/components/schemas/Response"
            text/json:
              schema:
                $ref: "#/components/schemas/Response"
        "403":
          description: Forbidden. Token lacks partyId, tenant FGA read/write
            authorization, or contains a present but blank/malformed configured
            username claim on a write.
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/Response"
            application/json:
              schema:
                $ref: "#/components/schemas/Response"
            text/json:
              schema:
                $ref: "#/components/schemas/Response"
        "503":
          description: Service Unavailable (503). FGA returned an unavailable/unusable
            result, or the selected tenant has duplicate active lookup names and
            Orion will not choose an arbitrary ID.
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/Response"
            application/json:
              schema:
                $ref: "#/components/schemas/Response"
            text/json:
              schema:
                $ref: "#/components/schemas/Response"
      security:
        - Bearer: []
security:
  - Bearer: []
components:
  schemas:
    CallEntryIEnumerablePagedResponse:
      type: object
      properties:
        message:
          type: string
          nullable: true
        items:
          type: array
          items:
            $ref: "#/components/schemas/CallEntry"
          nullable: true
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        firstPage:
          type: string
          format: uri
          nullable: true
        lastPage:
          type: string
          format: uri
          nullable: true
        totalPages:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
        nextPage:
          type: string
          format: uri
          nullable: true
        previousPage:
          type: string
          format: uri
          nullable: true
      additionalProperties: false
    Response:
      type: object
      properties:
        message:
          type: string
          nullable: true
      additionalProperties: false
    CallEntry:
      required:
        - callEntryID
        - clientCode
        - createdByUser
        - createdDate
        - lastUpdatedDate
      type: object
      properties:
        clientCode:
          minLength: 1
          type: string
        callEntryID:
          type: integer
          format: int32
        callerTypeID:
          type: integer
          format: int32
          nullable: true
        callerType:
          type: string
          nullable: true
        callTypeID:
          type: integer
          format: int32
          nullable: true
        callType:
          type: string
          nullable: true
        productTypeID:
          type: integer
          format: int32
          nullable: true
        productType:
          type: string
          nullable: true
        contract:
          type: string
          nullable: true
        priority:
          type: integer
          format: int32
          nullable: true
        notes:
          type: string
          nullable: true
        survey:
          type: string
          nullable: true
        isExchange:
          type: boolean
          nullable: true
        isSuspended:
          type: boolean
          nullable: true
        isFollowUpCompleted:
          type: boolean
          nullable: true
        followUpRequestedDate:
          type: string
          format: date-time
          nullable: true
        followUpCompletedDate:
          type: string
          format: date-time
          nullable: true
        suspendedUntilDate:
          type: string
          format: date-time
          nullable: true
        createdByUser:
          minLength: 1
          type: string
        createdDate:
          type: string
          format: date-time
        lastUpdatedDate:
          type: string
          format: date-time
        callTime:
          type: string
          format: date-time
          nullable: true
        callerName:
          type: string
          nullable: true
        phoneFaxNum:
          type: string
          nullable: true
        reference:
          type: string
          nullable: true
        isWatchOne:
          type: boolean
          nullable: true
        isWatchTwo:
          type: boolean
          nullable: true
        transactionTypeID:
          type: integer
          format: int32
          nullable: true
        transactionType:
          type: string
          nullable: true
        isEscalated:
          type: boolean
          nullable: true
        initiatedDate:
          type: string
          format: date-time
          nullable: true
        completeInOrion:
          type: boolean
          nullable: true
        isWatchThree:
          type: boolean
          nullable: true
        transactionAmount:
          type: number
          format: double
          nullable: true
        sessionID:
          type: string
          nullable: true
        authStatus:
          type: string
          nullable: true
        dob:
          type: string
          format: date-time
          nullable: true
        ssn:
          type: string
          nullable: true
        callSummary:
          type: string
          nullable: true
        callSummaryDate:
          type: string
          format: date-time
          nullable: true
        documentNumber:
          type: string
          nullable: true
        callId:
          type: string
          nullable: true
        contracts:
          type: array
          items:
            $ref: "#/components/schemas/CallEntryContract"
          nullable: true
      additionalProperties: false
    CallEntryContract:
      required:
        - callTypes
        - contractNumber
      type: object
      properties:
        contractNumber:
          minLength: 1
          type: string
        callTypes:
          type: array
          items:
            type: string
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: Supply an OAuth bearer token obtained from Auth0.
      scheme: bearer
      bearerFormat: JWT
```