api.jobs.get

GET /job/{jobDisplayId} — ACPortal

Python

api.jobs.get(job_display_id: int) -> Job

CLI

ab jobs get <job_display_id>

GET /job/{jobDisplayId} (ACPortal)

Retrieve a job by its display ID.

Args: job_display_id: The numeric display ID of the job.

Returns: :class:~ab.api.models.jobs.Job

Response

Returns Job.

Field	Type	Required	Description
isActive	Optional[bool]	no	Whether the record is active
createdDate	Optional[datetime]	no	Creation timestamp
modifiedDate	Optional[datetime]	no	Last modification timestamp
createdBy	Optional[str]	no	Creator identifier
modifiedBy	Optional[str]	no	Last modifier identifier
id	str | int | None	no	Unique identifier
jobDisplayId	Optional[int]	no	Human-readable job ID
status	Optional[str]	no	Job status
customer	Optional[dict]	no	Customer details
pickup	Optional[dict]	no	Pickup info
delivery	Optional[dict]	no	Delivery info
items	Optional[list[JobItem]]	no	Line items
bookedDate	Optional[str]	no	Booking date
ownerCompanyId	Optional[str]	no	Owner company UUID
customerContact	Optional[JobContactDetails]	no	Customer contact details
pickupContact	Optional[JobContactDetails]	no	Pickup contact details
deliveryContact	Optional[JobContactDetails]	no	Delivery contact details
totalSellPrice	Optional[float]	no	Total sell price
freightItems	Optional[list[JobFreightItem]]	no	Freight shipment items
jobSummarySnapshot	Optional[JobSummarySnapshot]	no	Financial/weight summary snapshot
notes	Optional[list[dict]]	no	Job notes
activeOnHoldInfo	Optional[ActiveOnHoldInfo]	no	Active on-hold details
writeAccess	Optional[bool]	no	User write access flag
accessLevel	Optional[int]	no	User access level bitmask
statusId	Optional[str]	no	Job status UUID
jobMgmtSubId	Optional[str]	no	Job management sub UUID
isCancelled	Optional[bool]	no	Cancelled flag
freightInfo	Optional[JobFreightInfo]	no	Freight tracking summary
freightProviders	Optional[list[dict]]	no	Freight provider options
expectedPickupDate	Optional[str]	no	Expected pickup date
expectedDeliveryDate	Optional[str]	no	Expected delivery date
timelineTasks	Optional[list[dict]]	no	Timeline task entries
documents	Optional[list[JobDocument]]	no	Attached documents
labelRequestSentDate	Optional[str]	no	Label request sent date
paymentInfo	Optional[JobPaymentInfo]	no	Payment status
agentPaymentInfo	Optional[JobAgentPaymentInfo]	no	Agent payment info
slaInfo	Optional[JobSlaInfo]	no	SLA tracking info
jobType	Optional[str]	no	Job type
prices	Optional[list[dict]]	no	Price entries

---

← Back to api.jobs