Jobs

Prev Next

Description

Jobs represent scheduled or completed work and are associated with an Opportunity. This endpoint provides status, identifiers, and tracking metadata for individual jobs.

Resource overview

EndpointDefinition
GET /JobsRetrieve a list of Jobs and related details.

Attributes

AttributeDescriptionData typeNotes
JobIDUnique identifier for the jobintegerRequired
OpportunityIDAssociated Opportunity IDintegerOptional
JobStatusIDStatus of the jobintegerOptional
CustomerJobNumCustomer-facing job referencestringOptional; Max length: 50
CustomerPOCustomer purchase order numberstringOptional; Max length: 50
CompleteDateDate job was completedstring (date-time)Optional
CompletedUserIDID of the user who completed the jobintegerOptional
CreatedByUserNameUsername of the job creatorstringOptional
CancelDateDate job was canceledstring (date-time)Optional
CanceledByUserIDID of the user who canceled the jobintegerOptional
CanceledFromOpportunityIndicates if job was canceled from the Opportunity viewbooleanOptional