api.jobs.on_hold.list_followup_users

GET /job/{jobDisplayId}/onhold/followupusers — ACPortal

Python

api.jobs.on_hold.list_followup_users(job_display_id: int) -> list[OnHoldUser]

CLI

ab jobs on_hold list_followup_users <job_display_id>

List all follow-up users available for the job.

Response

Returns a list of List[OnHoldUser].

Field

Type

Required

Description

contactId

Optional[int]

no

Contact ID

name

Optional[str]

no

User name

email

Optional[str]

no

User email

fullName

Optional[str]

no

Full display name

jobRelation

Optional[str]

no

Relation to the job (e.g. Pickup Agent, Owner)


← Back to api.jobs