`api.lookup.get_access_key`

GET /lookup/accessKey/{accessKey} — ACPortal

Python

api.lookup.get_access_key(access_key: str) -> AccessKeySetup

CLI

ab lookup get_access_key <access_key>

GET /lookup/accessKey/{accessKey}

Response

Returns AccessKeySetup.

Field	Type	Required	Description
`accessKey`	`Optional[str]`	no	Access key string
`friendlyName`	`Optional[str]`	no	Friendly display name
`userId`	`Optional[str]`	no	User ID (Guid)
`userIdentifier`	`Optional[int]`	no	User identifier (int)
`referredById`	`Optional[str]`	no	Referred by ID (Guid)
`referredBy`	`Optional[str]`	no	Referred by name
`useAgentSearch`	`Optional[bool]`	no	Use agent search
`allowJobInfoUpdate`	`Optional[bool]`	no	Allow job info update
`allowJobInfoUpdateWithoutBookingKey`	`Optional[bool]`	no	Allow update without booking key
`ipProtections`	`Optional[list]`	no	IP protection rules
`parcelTransportationMultiplier`	`Optional[float]`	no	Parcel transportation multiplier
`parcelAccessorialMultiplier`	`Optional[float]`	no	Parcel accessorial multiplier
`itemsCombineMaxInches`	`Optional[int]`	no	Max combine inches
`usePackLaborCalculation`	`Optional[bool]`	no	Use pack labor calculation
`useBasePickupFeeCalculation`	`Optional[bool]`	no	Use base pickup fee calculation
`forceAgentPickup`	`Optional[bool]`	no	Force agent pickup