api.lookup.get_by_key

GET /lookup/{masterConstantKey} — ACPortal

Python

api.lookup.get_by_key(key: str | MasterConstantKey) -> list[LookupValue]

CLI

ab lookup get_by_key <key>

GET /lookup/{masterConstantKey}

Args: key: A master-constant GROUP key (e.g. "OnHoldReason", "Job Management Status"), NOT one of its values — see :class:~ab.api.models.enums.MasterConstantKey for every known key. The API returns [] (not 404) for an unknown key, so a misspelt key looks like an empty group.

Response

Returns a list of List[LookupValue].

Field	Type	Required	Description
id	str | int | None	no	Value ID (Guid, or int for ContactTypes)
key	Optional[str]	no	Master data key
name	Optional[str]	no	Display name
value	Optional[str]	no	Value (Guid)

---

← Back to api.lookup