Field NationDeveloper Platform
Field NationDeveloper Platform
IntroductionQuick StartAPI Playground

Getting Started

API Reference

Overview
MessagesAttachmentsContacts
Work OrdersCommunication

Contacts

Manage site contacts for work orders.


Contacts

Contacts provide the provider with on-site contact information - who to call when they arrive, who can grant access, etc.

List Contacts

GET /workorders/{id}/contacts

Response

{
  "results": [
    {
      "id": 101,
      "name": "John Doe",
      "role": "Location Contact",
      "phone": "+1-555-123-4567",
      "ext": "101",
      "email": "john.doe@store.com",
      "notes": "Available Mon-Fri 9am-5pm"
    },
    {
      "id": 102,
      "name": "Jane Smith",
      "role": "Technical help",
      "phone": "+1-555-987-6543",
      "email": "jane.smith@store.com"
    }
  ]
}

Create Contact

POST /workorders/{id}/contacts

{
  "name": "John Doe",
  "role": "Location Contact",
  "phone": "+1-555-123-4567",
  "ext": "101",
  "email": "john.doe@store.com",
  "notes": "Available during business hours"
}

Update Contact

PUT /workorders/{id}/contacts/{contact_id}

{
  "phone": "+1-555-999-8888"
}

Delete Contact

DELETE /workorders/{id}/contacts/{contact_id}

At least one contact should remain on the work order so the provider has someone to reach on-site.

Contact Roles

Available contact roles (use exact values):

RoleDescription
Project managerPrimary project authority
Location ContactOn-site contact person
Resource coordinatorResource scheduling
Emergency contactEmergency situations
Technical helpTechnical questions
Check-in / Check-outCheck-in verification

Phone Visibility

Contact phone numbers are visible to assigned providers. For privacy:

  • Use work phones, not personal numbers
  • Remove contacts after work completion if needed

Contact at Creation

Include contacts when creating a work order:

{
  "title": "Router Installation",
  "contacts": {
    "results": [
      {
        "name": "John Doe",
        "role": "Location Contact",
        "phone": "+1-555-123-4567",
        "notes": "Ask for IT department"
      }
    ]
  }
}

Related

  • Signatures - Contacts may need to sign
  • Messages - Communicate about contacts

Last updated on

Attachments

Upload and manage files on work orders.

Schedule

Manage work order scheduling and ETAs.

On this page

Contacts
List Contacts
Response
Create Contact
Update Contact
Delete Contact
Contact Roles
Phone Visibility
Contact at Creation
Related