Orion-API

List active call types

Returns active canonical tenant call types, sorted by name, using FGA read authorization. X-Client-Code is required. Names are trimmed and matched case-insensitively by write operations; an unknown/inactive name returns field-specific 400, while duplicate active names return 503 and are logged as a configuration defect. A lookup rename is an API compatibility change.

get
https://qa.api.zinnia.io/callcenter/v1/lookups/call-types

Headers

X-Client-Codestringrequired

Required tenant selector. Trimmed and resolved case-insensitively to a canonical configured tenant before FGA authorization; missing, blank, or unknown values return 400.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Response

OK

LookupResponse

Tenant-scoped active lookup values using canonical compatibility-stable names.

* Additional properties are NOT allowed.
clientCodestring | null

Canonical tenant code selected by X-Client-Code.

itemsarray | null[object]

Active values sorted by name.

* Additional properties are NOT allowed.
Show Child Parameters
get/callcenter/v1/lookups/call-types
 

List active caller types

Returns active canonical tenant caller types, sorted by name, using FGA read authorization. X-Client-Code is required. Names are trimmed and matched case-insensitively by write operations; an unknown/inactive name returns field-specific 400, while duplicate active names return 503 and are logged as a configuration defect. A lookup rename is an API compatibility change.

get
https://qa.api.zinnia.io/callcenter/v1/lookups/caller-types

Headers

X-Client-Codestringrequired

Required tenant selector. Trimmed and resolved case-insensitively to a canonical configured tenant before FGA authorization; missing, blank, or unknown values return 400.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Response

OK

LookupResponse

Tenant-scoped active lookup values using canonical compatibility-stable names.

* Additional properties are NOT allowed.
clientCodestring | null

Canonical tenant code selected by X-Client-Code.

itemsarray | null[object]

Active values sorted by name.

* Additional properties are NOT allowed.
Show Child Parameters
get/callcenter/v1/lookups/caller-types
 

List active transaction types

Returns active canonical tenant transaction types, sorted by name, using FGA read authorization. X-Client-Code is required. Names are trimmed and matched case-insensitively by write operations; an unknown/inactive name returns field-specific 400, while duplicate active names return 503 and are logged as a configuration defect. A lookup rename is an API compatibility change.

get
https://qa.api.zinnia.io/callcenter/v1/lookups/transaction-types

Headers

X-Client-Codestringrequired

Required tenant selector. Trimmed and resolved case-insensitively to a canonical configured tenant before FGA authorization; missing, blank, or unknown values return 400.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Response

OK

LookupResponse

Tenant-scoped active lookup values using canonical compatibility-stable names.

* Additional properties are NOT allowed.
clientCodestring | null

Canonical tenant code selected by X-Client-Code.

itemsarray | null[object]

Active values sorted by name.

* Additional properties are NOT allowed.
Show Child Parameters
get/callcenter/v1/lookups/transaction-types
 

List active product types

Returns active canonical tenant product types, sorted by name, using FGA read authorization. X-Client-Code is required. Names are trimmed and matched case-insensitively by write operations; an unknown/inactive name returns field-specific 400, while duplicate active names return 503 and are logged as a configuration defect. A lookup rename is an API compatibility change.

get
https://qa.api.zinnia.io/callcenter/v1/lookups/product-types

Headers

X-Client-Codestringrequired

Required tenant selector. Trimmed and resolved case-insensitively to a canonical configured tenant before FGA authorization; missing, blank, or unknown values return 400.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Response

OK

LookupResponse

Tenant-scoped active lookup values using canonical compatibility-stable names.

* Additional properties are NOT allowed.
clientCodestring | null

Canonical tenant code selected by X-Client-Code.

itemsarray | null[object]

Active values sorted by name.

* Additional properties are NOT allowed.
Show Child Parameters
get/callcenter/v1/lookups/product-types
 

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.

get
https://qa.api.zinnia.io/callcenter/v1/CallEntry

Query Parameters

clientCodestring

Deprecated: use X-Client-Code. 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.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Contractstring

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.

Match pattern:^[A-Za-z0-9,-]+$

>= 1 characters<= 200 characters

Example:C-10001

CallerTypeIDinteger(int32)

Matches the call entry’s caller-type ID.

CallerTypestring

Matches the call entry’s caller-type name.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

Example:Owner

CallerNamestring

Matches the caller name exactly unless usePartialCallerNameMatch is true.

Match pattern:^[A-Za-z ,.'-]+$

>= 1 characters<= 500 characters

Example:Jane

UsePartialCallerNameMatchboolean

When true, callerName may occur anywhere within the stored caller name. When false, the names must match exactly. Defaults to false.

CallTypeIDinteger(int32)

Matches a call-type ID assigned directly to the call entry or to one of its contracts.

CallTypestring

Matches a call-type name assigned directly to the call entry or to one of its contracts.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

Example:Billing

TransactionTypeIDinteger(int32)

Matches the call entry’s transaction-type ID.

TransactionTypestring

Matches the call entry’s transaction-type name.

Match pattern:^[A-Za-z0-9 &'/-]+$

>= 1 characters<= 50 characters

Example:Payment

CreatedStartDatestring(date-time)

Includes entries created at or after this date and time.

CreatedEndDatestring(date-time)

Includes entries created at or before this date and time.

LastUpdatedStartDatestring(date-time)

Includes entries last updated at or after this date and time.

LastUpdatedEndDatestring(date-time)

Includes entries last updated at or before this date and time.

Offsetinteger(int32)

Number of results to skip. Defaults to 0; negative values are treated as 0.

>= 0

Example:0

Limitinteger(int32)

Maximum number of results to return. Defaults to 50; values above 500 are limited to 500, and non-positive values use the default.

>= 1<= 500

Example:50

Headers

X-Client-Codestring

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.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Response

OK

CallEntryIEnumerablePagedResponse

* Additional properties are NOT allowed.
messagestring | null
itemsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
offsetinteger(int32)
limitinteger(int32)
firstPagestring | null(uri)
lastPagestring | null(uri)
totalPagesinteger(int32)
totalCountinteger(int32)
nextPagestring | null(uri)
previousPagestring | null(uri)
get/callcenter/v1/CallEntry