--- title: "Get a call entry" url: "https://developers.zinnia.com/apis/orion-api/versions/716288b7-e96e-41a7-abc5-63925410717a/operations/get-call-entry" --- > Full API specification: https://developers.zinnia.com/apis/orion-api/versions/716288b7-e96e-41a7-abc5-63925410717a.md # Get a call entry `GET` `/callcenter/v1/CallEntry/{callEntryId}` Operation ID: `get-call-entry` Retrieves one complete `CallEntry` by its ID. The caller must have read access to the company that owns the record. Identify the company with `X-Client-Code` or the backward-compatible `clientCode` query parameter. At least one is required. If both are supplied with different values, the query parameter takes precedence. Orion returns `404 Not Found` when the record does not exist in the selected company. ## Path parameters - `callEntryId` (integer, int32, required) ## 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. ## 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. - `404` - Not Found. The requested call entry does not exist in the selected tenant. - `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/{callEntryId}: get: tags: - Call Entries summary: Get a call entry description: >- Retrieves one complete `CallEntry` by its ID. The caller must have read access to the company that owns the record. Identify the company with `X-Client-Code` or the backward-compatible `clientCode` query parameter. At least one is required. If both are supplied with different values, the query parameter takes precedence. Orion returns `404 Not Found` when the record does not exist in the selected company. operationId: get-call-entry parameters: - name: callEntryId in: path required: true schema: type: integer format: int32 - 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: 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/CallEntry" application/json: schema: $ref: "#/components/schemas/CallEntry" text/json: schema: $ref: "#/components/schemas/CallEntry" "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" "404": description: Not Found. The requested call entry does not exist in the selected tenant. 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: 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 Response: type: object properties: message: type: string 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 ```