Outbound Integration: Payload Reference

Overview:

This guide is a technical reference to the structure and formatting of outbound project and job payloads sent through our Automations. You can read more about configuring your own Outbound Integrations here and more on our Automation here. Some notable absences in the job and project payload include survey information, billing invoices, billing line items, materials, and equipment.

Warning: this doc is long and very technical. It is intended as a reference doc for developers working to get project information out of Supermove.

Overall Structure:

{
  "jobs": [
    {
      "tags": [],
      "uuid": "b0123f9a-1fa8-4885-b3e5-e916ea70c2af",
      "status": "LEAD",
      "values": {
        "JOB_NUMBER_OF_MOVERS": 2,
        "JOB_NUMBER_OF_TRUCKS": 1,
        "JOB_MAX_ESTIMATE_HOURS": 2,
        "JOB_MIN_ESTIMATE_HOURS": 2
      },
      "end_date": "2025-10-16",
      "job_type": { 
        "kind": "MOVE", 
        "name": "Move" 
      },
      "locations": [
        {
          "city": "Seffner",
          "name": "",
          "notes": "",
          "state": "FL",
          "address": "2808 Beagle Pl, Seffner, FL, USA",
          "country": "US",
          "latitude": 27.9703638,
          "zip_code": "33584",
          "longitude": -82.267517,
          "stair_count": 0,
          "building_size": null,
          "building_type": "House"
        },
        {
          "city": "Owings Mills",
          "name": "",
          "notes": "",
          "state": "MD",
          "address": "4606 Cascade Mills Dr, Owings Mills, MD, USA",
          "country": "US",
          "latitude": 39.4012644,
          "zip_code": "21117",
          "longitude": -76.8064986,
          "stair_count": 0,
          "building_size": null,
          "building_type": "Apartment"
        }
      ],
      "crew_notes": "",
      "identifier": "3735-1",
      "start_date": "2025-10-16",
      "mover_names": null,
      "truck_names": null,
      "office_notes": "Needs packed and delivered quickly due to time constraints.",
      "start_time_1": "0900",
      "start_time_2": "",
      "labor_sources": [ 
        { 
          "name": "Test Labor Source", 
          "identifier": "testsource" 
        } 
      ],
      "dispatch_notes": ""
    }
  ],
  "tags": ["Sample Tag"],
  "uuid": "ca553542-badd-4ee4-89da-65a6a8934b27",
  "client": {
    "name": "John Doe",
    "uuid": "dd94c92b-6392-4f52-8c69-32e17717123a",
    "primary_contact": {
      "email": "johndoe@gmail.com",
      "full_name": "John Doe",
      "phone_number": "9161234567"
    }
  },
  "status": "LEAD",
  "project_type": {
    "name": "Intrastate Move",
    "color": "#9B51E0"
  },
  "values": {
    "PROJECT_SIZE": "",
    "PROJECT_BRANCH": "timsandboxsolomon",
    "PROJECT_WEIGHT": 0,
    "PROJECT_TOTAL_REVENUE": 0,
    "PROJECT_INVENTORY_PRICE": 0,
    "PROJECT_INVENTORY_VOLUME": 0
  },
  "end_date": "2025-10-16",
  "identifier": "3735",
  "start_date": "2025-10-16",
  "coordinator": {
      "email": "jane@supermove.co",
      "full_name": "Jane Doe",
      "phone_number": ""
  },
  "description": "",
  "salesperson": {
      "email": "integrations@supermove.co",
      "full_name": "Integration",
      "phone_number": ""
  },
  "is_cancelled": false,
  "office_notes": "Time sensitive move, pickup on the 16th and delivery on the 18th."
}

Note: values may be null or an empty string depending on how the project and job are populated in the Supermove Office App.

Property	Data Type	Description
"uuid"	string	Unique project identifier.
"identifier"	string	Human‑readable project number shown in the Office App.
"status"	string	Project status at the time the automation fires.
"project_type"	object	`{ name, color }` describing the project type name and its UI color.
"booking_status"	string	Booking stage for the project.
"project_type"	object	`{ name, color }` describing the project type name and its UI color.
"client"	Client Object	Details on the client associated with the project. See Client Object section below for more details.
"coordinator"	Person Object	Assigned coordinator, if any. See Person Object section below for more details.
"salesperson"	Person Object	Assigned salesperson, if any. See Person Object section below for more details.
"description"	string	The projects description.
"start_date"	string	Start date of the project, will be in YYYY-MM-DD format.
"end_date"	string	End date of the project, will be in YYYY-MM-DD format.
"tags"	array of strings	Correspond to the project tags configured in your Supermove account that have been assigned to this job.
"is_cancelled"	boolean	Indicates if this project has been cancelled or not.
"office_notes"	string	The project's office notes.
"referral_source"	string	From Internal Information -> How Did You Hear About Us? in the Supermove project.
"referral_details"	string	From Internal Information -> Referral Details in the Supermove project.
"additional_salespersons"	string	Please see Person Object section below for more details.
"jobs"	array of Job Objects	Please see Job Object section below.
"values"	object	Free-form object with the project's assigned billing variables and their values.

Job Object:

{
  "tags": [],
  "uuid": "b0123f9a-1fa8-4885-b3e5-e916ea70c2af",
  "status": "LEAD",
  "values": {
    "JOB_NUMBER_OF_MOVERS": 2,
    "JOB_NUMBER_OF_TRUCKS": 1,
    "JOB_MAX_ESTIMATE_HOURS": 2,
    "JOB_MIN_ESTIMATE_HOURS": 2
  },
  "end_date": "2025-10-16",
  "job_type": {
    "kind": "MOVE",
    "name": "Move"
  },
  "locations": [
    {
      "city": "Seffner",
      "name": "",
      "notes": "",
      "state": "FL",
      "address": "2808 Beagle Pl, Seffner, FL, USA",
      "country": "US",
      "latitude": 27.970363800000,
      "zip_code": "33584",
      "longitude": -82.267517000000,
      "stair_count": 0,
      "building_size": null,
      "building_type": "House"
    },
    {
      "city": "Owings Mills",
      "name": "",
      "notes": "",
      "state": "MD",
      "address": "4606 Cascade Mills Dr, Owings Mills, MD, USA",
      "country": "US",
      "latitude": 39.401264400000,
      "zip_code": "21117",
      "longitude": -76.806498600000,
      "stair_count": 0,
      "building_size": null,
      "building_type": "Apartment"
    }
  ],
  "crew_notes": "",
  "identifier": "3735-1",
  "start_date": "2025-10-16",
  "mover_names": null,
  "truck_names": null,
  "office_notes": "Needs packed and delivered quickly due to time constraints.",
  "start_time_1": "0900",
  "start_time_2": "",
  "labor_sources": [
    {
      "name": "Test Labor Source",
      "identifier": "testsource"
    }
  ],
  "dispatch_notes": ""
}

Note: All values may be null or an empty string.

Property	Data Type	Description
"uuid"	string	The unique identifier for this job.
"identifier"	string	Job identifier. Will be the same as the one displayed in the office app.
"status"	string	The status of the job.
"values"	object	Free-form object with the job's assigned billing variables and their values.
"tags"	array of strings	Correspond to the job tags configured in your Supermove account that have been assigned to this job.
"start_date"	string	Start date of the job, will be in YYYY-MM-DD format.
"end_date"	boolean	End date of the job, will be in YYYY-MM-DD format.
"job_type"	object	`{ name, color }` describing the job type name and its UI color.
"locations"	array of location objects	See Location Object section below.
"crew_notes"	string	Crew notes from the Supermove office app.
"mover_names"	string	Assigned movers will have their names aggregated into comma separated values in string format.
"truck_names"	string	Assigned trucks will have their names aggregated into comma separated values in string format.
"office_notes"	string	Office notes from the Supermove office app.
"start_time_1"	string	The starting time in HHMM format.
"start_time_2"	string	The end time in HHMM format.
"labor_sources"	array of objects	Assigned labor sources. Each object will have `{ name, identifier }` describing the name of the labor source and the labor source's identifier.
"dispatch_notes"	string	Dispatch notes from the Supermove office app.

Client Object:

{
  "name": "John Doe",
  "uuid": "ec00fa80-ee7c-4d79-a3cf-5e3972549eed",
  "primary_contact": {
      "email": "johndoe@supermove.com",
      "full_name": "John Doe",
      "phone_number": "9161234567"
  }
}

Property	Data Type	Description
"name"	string	The client's name.
"uuid"	string	The unique identifier for this client.
"primary_contact"	person object	Please see Person Object section below.

Person Object:

{
  "email": "integrations@supermove.co",
  "full_name": "Integration",
  "phone_number": ""
},

Property	Data Type	Description
"full_name"	string	Combined first and last name for the person. This often mirrors the name in the client and billing client objects, if nested within those two objects.
"email"	string	The email of person.
"phone_number"	string	The phone number of the person. Conforms to US/Canadian phone formats.

Location Object:

{
  "city": "Seffner",
  "name": "",
  "notes": "",
  "state": "FL",
  "address": "2808 Beagle Pl, Seffner, FL, USA",
  "country": "US",
  "latitude": 27.970363800000,
  "zip_code": "33584",
  "longitude": -82.267517000000,
  "stair_count": 0,
  "building_size": null,
  "building_type": "House"
}

Property	Data Type	Description
"name"	string	The name of the location.
"address"	string	The full address of the location.
"city"	string	The address' city.
"zip_code"	string	The address' zip code.
"notes"	string	Free form notes about the location
"stair_count"	integer	The number of flights of stairs.
"building_type"	string	The locations building type.
"country"	string	The country code of the location.
"building_size"	string	The building size at the address.
"latitude"	float	The latitude of the address. Populated through geocoding.
"longitude"	float	The longitude of the address. Populated through geocoding.

Have questions? Please reach out to our Product Experts Team at help@supermove.com for assistance.

Search

Overview:

Overall Structure:

Job Object:

Client Object:

Person Object:

Location Object:

Comments

Search

Overview:

Overall Structure:

Job Object:

Client Object:

Person Object:

Location Object:

Related articles