Contact.GetAll

Endpoint

Method: GET
Route: Contact/GetAll
Authentication: Authorize

Returns the contacts for an account. When customerCode is omitted, the account is resolved from the caller's token (CustomerCode claim). Account administrators can read contacts on bill-to accounts listed in AdditionalWebAccess by supplying customerCode. Master contacts (configured MasterContactCode for the tenant, with API key) can read contacts under any account by supplying customerCode.

Request Schema

Headers

Header	Required	Notes
`X-Api-Key`	Required when tenant is not resolved by subdomain	Resolves the tenant/customer database. Also required for master-contact elevation.
`Authorization: Bearer {token}`	Required for authorized endpoints	Get a token from `Auth/Token` or `Session/Create`.

Query Parameters

Parameter	Type	Required	Default	Notes
`includeRetired`	`bool`	No	`false`	When `true`, retired contacts are included in the results.
`customerCode`	`string`	No		Target account. When omitted, uses the caller's `CustomerCode` claim. A different account requires master contact access, or an account administrator whose allowed set includes that code.

This endpoint does not accept a JSON request body.

Scoping And Visibility

Results are scoped to the target account (customerCode, or the caller's account when omitted).
Retired contacts are excluded by default. Pass includeRetired=true to include them; each item carries a retired flag so callers can distinguish them.
On the caller's own account, a contact flagged to limit search to their own orders only sees their own contact record, unless the contact is an account Administrator. That self-only restriction does not apply when reading another allowed account.

Expected Response Schema

Status Codes

Status	Notes
`200 OK`	Returned by the controller for this operation. An unauthorized or unknown `customerCode` returns an empty list.

Success Body

Response type: IReadOnlyList<ContactLookupDto>

Field	Type	Notes
`code`	`int`	Contact code (primary key within the account).
`customerCode`	`string`	Account the contact belongs to. Trailing CHAR padding is trimmed.
`contact`	`string`	Contact display name.
`email`	`string`	Contact email address.
`phone`	`string`
`fax`	`string`
`defaultCourtState`	`string`	Contact's default court state.
`defaultCourtCounty`	`string`	Contact's default court county.
`webAccess`	`string`	Web access level: `None`, `CopyService`, `AttorneyService`, `Both`, `Administrator`, or `Unknown`.
`retired`	`bool`	`true` when the contact is retired.

Response Sample

[
  {
    "code": 456,
    "customerCode": "8888",
    "contact": "Maria Contact",
    "email": "maria.contact@example.com",
    "phone": "2135550100",
    "fax": "2135550101",
    "defaultCourtState": "CA",
    "defaultCourtCounty": "Los Angeles",
    "webAccess": "AttorneyService",
    "retired": false
  }
]