Sheriff Reports

Sheriff's reports document the results of serving court processes (summons, writs, notices) for a case.

The sheriff report shape

  • Name
    id
    Type
    string
    Description

    The underlying case activity's UUID.

  • Name
    case_record_id
    Type
    string
    Description

    The case record this report belongs to.

  • Name
    activity
    Type
    string
    Description

    Always "Sheriff's Report" for this resource.

  • Name
    tag
    Type
    string
    Description

    Always "Sheriff's Report" — this is the filter key used by the underlying query.

  • Name
    status
    Type
    string
    Description

    One of Confirmed, Expunged, Granted, Denied, for_update.

  • Name
    service_date
    Type
    date | null
    Description

    Date of the (most recent) service attempt.

  • Name
    service_status
    Type
    string | null
    Description

    Result of the service attempt, e.g. served, unserved, refused.

  • Name
    service_reason
    Type
    string | null
    Description

    Reason recorded for the service outcome (especially when unserved/refused).

  • Name
    manner_of_service
    Type
    string | null
    Description

    How the process was served, e.g. personal, substituted.

  • Name
    attachments
    Type
    array
    Description

    Attached scanned returns/proofs of service (case_activity_attachments media collection).


GET/api/sheriff-reports

List sheriff reports

Retrieve sheriff's reports for cases assigned to the authenticated Sheriff's branches.

Request

GET
/api/sheriff-reports
curl https://your-domain.com/api/sheriff-reports \
  -H "Accept: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}"

Response

{
  "data": [
    {
      "id": "2b3c4d5e-6f7a-8901-2b3c-4d5e6f7a8901",
      "case_record_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "activity": "Sheriff's Report",
      "tag": "Sheriff's Report",
      "status": "for_update",
      "service_date": null,
      "service_status": null
    }
  ]
}

POST/api/backoffice/case/{caseId}/activities-sheriff

Submit a sheriff's report

Record a service attempt against a hearing, creating a Sheriff's Report activity threaded under it.

Path parameters

  • Name
    caseId
    Type
    string
    Description

    The UUID of the case record.

Required attributes

  • Name
    hearing_parent_id
    Type
    string
    Description

    The activity id of the hearing this service relates to.

  • Name
    service_date
    Type
    date
    Description

    The date the service attempt occurred.

  • Name
    service_status
    Type
    string
    Description

    e.g. served, unserved, refused.

  • Name
    manner_of_service
    Type
    string
    Description

    e.g. personal, substituted.

Request

POST
/api/backoffice/case/{caseId}/activities-sheriff
curl -X POST https://your-domain.com/api/backoffice/case/a1b2c3d4-e5f6-7890-abcd-ef1234567890/activities-sheriff \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}" \
  -d '{
    "hearing_parent_id": "e5f6a7b8-c9d0-1234-ef56-7890abcdef12",
    "service_date": "2026-02-18",
    "service_status": "served",
    "manner_of_service": "personal"
  }'

Response

{
  "data": {
    "id": "2b3c4d5e-6f7a-8901-2b3c-4d5e6f7a8901",
    "activity": "Sheriff's Report",
    "service_date": "2026-02-18",
    "service_status": "served",
    "manner_of_service": "personal",
    "status": "Confirmed"
  }
}

POST/api/backoffice/update-sheriff-report

Update a sheriff's report

Replace the attached scanned return/proof-of-service files on an existing sheriff's report.

Required attributes

  • Name
    case_activity_id
    Type
    string
    Description

    The UUID of the sheriff's report activity to update.

  • Name
    attachments
    Type
    file[]
    Description

    One or more files to attach, replacing the existing case_activity_attachments media.

Request

POST
/api/backoffice/update-sheriff-report
curl -X POST https://your-domain.com/api/backoffice/update-sheriff-report \
  -H "Accept: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}" \
  -F "case_activity_id=2b3c4d5e-6f7a-8901-2b3c-4d5e6f7a8901" \
  -F "attachments[]=@/path/to/return-of-service.pdf"

Response

{
  "message": "Sheriff's report updated successfully."
}

Was this page helpful?