Serves

Get a serve by token

Retrieves detailed information about a serve using its public token

get/v2/serves/{token}

Request

  • Base URL: https://api-docs.proofserve.com
  • URL: https://api-docs.proofserve.com/v2/serves/{token}
  • Auth: none declared

Path parameters

tokenstring required

The serve's public token (e.g., SRV-ABCD123)

Response

Serve found

tokenstring required

External facing identifier for the serve

order_tokenstring

Token of the parent order

health'ACTION_REQUIRED' | 'BEHIND_SCHEDULE' | 'CANCELED' | 'COMPLETED' | 'ON_TRACK' | 'PAUSED' | 'UNDER_REVIEW' nullable

Health status of the serve

created_atstring date-time required

When the serve was created

updated_atstring date-time required

When the serve was last updated

plaintiffsstring[] required

List of plaintiff names from the latest job

defendantsstring[] required

List of defendant names from the latest job

court_statestring required

State abbreviation for the court

status'DRAFT' | 'ON_HOLD' | 'UNASSIGNED' | 'ASSIGNED' | 'IN_PROGRESS' | 'PENDING_NOTARY' | 'IN_REVIEW' | 'PENDING_RATING' | 'PENDING_FILING' | 'COMPLETED' | 'CANCELED' | 'REASSIGNED' | 'FILING_AFFIDAVIT' | 'MAILING' required

Current status of the serve

pausedboolean required

Whether the serve is currently paused

due_datestring date-time required

Due date for the serve

billing_numberstring

Client's billing/matter number

case_numberstring

Court case number

servee_namestring required

Name of the person being served

servee_type'INDIVIDUAL' | 'ENTITY' required

Type of servee (individual person or business entity)

latest_attempt_atstring date-time

When the last serve attempt was made

suit_amountinteger

Amount in controversy in cents

file_new_suitboolean required

Whether to file a new suit

file_affidavitboolean required

Whether to file an affidavit

unsuccessful_reason'CLIENT_REQUESTED_CANCELATION' | 'BAD_ADDRESS_OUT_OF_VENUE' | 'UNSUCCESSFUL_SERVE' | 'BAD_ADDRESS' | 'BAD_ADDRESS_VERIFIED' | 'BAD_ADDRESS_OUT_OF_VENUE_VERIFIED' | 'SERVEE_DECEASED' | 'REFUSAL' | 'AVOIDING_SERVICE' | 'AVOIDING_SERVICE_VERIFIED' | 'BANKRUPTCY' | 'PROPERTY_INACCESSIBLE' | 'INCARCERATED' | 'CLIENT_REQUESTED_CLOSURE' | 'ALTERNATIVE_SERVICE' | 'ALTERNATE_SERVICE_VERIFIED' | 'HARDSHIP' | 'UNSUCCESSFUL_VERIFIED_ADDRESS' | 'UNSUCCESSFUL_UNVERIFIED_ADDRESS' | 'OTHER' | 'VACANT_ADDRESS' | 'ADDRESS_LOW_CONFIDENCE_SCORE' | 'ADDRESS_LIMIT_REACHED' | 'BAD_ADDRESS_IN_VENUE' | 'MILITARY_SERVICE' | 'CLIENT_REQUESTED_OTHER' | 'HOSTILE_ENVIRONMENT' nullable

Reason why the serve was unsuccessful

Example response

{
  "token": "SRV-abc123",
  "order_token": "ORD-xyz789",
  "court_state": "TX",
  "addresses": [
    {
      "state": "TX"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.