GuildQuality offers several methods for retrieving data from and adding data to your GuildQuality account.
See below for general purpose documentation. You can also view more in-depth documentation on Postman.
Each request to the API is authenticated by an API bearer token which is unique to each member account. To activate your API credentials, go to Account > API.
Once your API credentials have been activated, make sure to keep them guarded. Anyone who has access to them will have access to your survey data as long as the credentials remain active. If you ever need new credentials for any reason, deactivate your current credentials then you’ll be provided with option to request new ones. Credentials are available on the API section of the Settings page of the GuildQuality app.
The following methods are currently available:
- Get Surveys
- Get Survey
- Add Customer
- Get Survey Templates
- Get Custom Fields
- Get Team Members
- Get Company Children
Get Surveys
Return company surveys.
URL
https://www.guildquality.com/company-api/v3/surveys
Format
JSON
HTTP Method
GET
Parameters
- Status
-
- Description: Return all surveys with the given status
- Format: enum(‘completed’, ‘scheduled’, ‘in-progress’, ‘no response’)
- Limit
- Description: Specifies the max number of surveys to return.
- Format: int
- Since
- Description: Return all completed surveys since the given date
- Format: YYYY-MM-DD
- Until
- Description: Return all completed surveys before the given date
- Format: YYYY-MM-DD
- Questions
- Description: Return all question data included on
- Format: To include questions set this parameter to 1. To exclude them, don’t include the parameter or set it to 0.
Sample of returned data:
{
"data": [
"id": 502995,
"contact": {
"id": 496388,
"name": "David Stone",
"email1": "DavidSStone@jourrapide.com",
"email2": "",
"phone1": "(904) 325-9937",
"phone2": ""
},
"project": {
"address": "3937 Kidd Avenue",
"city": "Anchorage",
"state": "AK",
"zip": "99501",
"customFilters": {
"Project Type": [
"Build"
],
"Warranty Type": [
"Platinum"
],
"Home Plan": [
"The Huston"
},
"template": "",
"endedAt": "2017-12-07T07:32:40 EST",
"completionMode": "phone",
"questions": [
"id": 6631182,
"order": 1,
"name": "Likely To Recommend",
"type": "both",
"rating": 4,
"comment": "",
"published": false
},
"id": 6631183,
"order": 2,
"name": "Warranty Service",
"type": "mcs",
"rating": "",
"comment": "",
"published": false
},
"id": 6631184,
"order": 3,
"name": "Extend Warranty",
"type": "mcs",
"rating": "",
"comment": "I would like to hear the different warranty options when we extend our warranty.",
"published": false
},
"id": 6631185,
"order": 4,
"name": "Additional Comments",
"type": "comment",
"rating": "",
"comment": "",
"published": false
},
"id": 503212,
"contact": {
"id": 496497,
"name": "Bertha Jorgensen",
"email1": "BerthaHJorgensen@rhyta.com",
"email2": "",
"phone1": "(904) 325-9937",
"phone2": ""
},
"project": {
"address": "1390 Kidd Avenue",
"city": "Oliktok",
"state": "AK",
"zip": "99501",
"customFilters": {
"Project Type": [
"Remodel"
],
"Warranty Type": [
"Diamond"
],
"Remodel Type": [
"Bathroom"
},
"template": "",
"endedAt": "2017-12-26T21:48:48 EST",
"completionMode": "phone",
"questions": [
"id": 6633562,
"order": 1,
"name": "Likely To Recommend",
"type": "both",
"rating": 5,
"comment": "I was very satisfied with the quality of the work that was done.",
"published": false
},
"id": 6633563,
"order": 2,
"name": "Clean",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633564,
"order": 3,
"name": "Safe",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633565,
"order": 4,
"name": "Respectful",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633566,
"order": 5,
"name": "Communication",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633567,
"order": 6,
"name": "Quality Of Materials",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633568,
"order": 7,
"name": "Quality Of Workmanship",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633569,
"order": 8,
"name": "Problem Resolution",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633570,
"order": 9,
"name": "Professional & Organized",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633571,
"order": 10,
"name": "Schedule",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633572,
"order": 11,
"name": "Value",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633573,
"order": 12,
"name": "Sales Knowledge",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633574,
"order": 13,
"name": "Recognized Excellence",
"type": "comment",
"rating": "",
"comment": "I would recognize the salesperson for their exceptional service.",
"published": false
},
"id": 6633575,
"order": 14,
"name": "Areas For Improvement",
"type": "comment",
"rating": "",
"comment": "",
"published": false
},
"id": 6633576,
"order": 15,
"name": "Areas Of Satisfaction",
"type": "comment",
"rating": "",
"comment": "They met my expectations with the quality of work. It was exceptional.",
"published": false
},
"id": 6633577,
"order": 16,
"name": "Design",
"type": "rating",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633578,
"order": 17,
"name": "Further Needs",
"type": "mcs",
"rating": "",
"comment": "",
"published": false
},
"id": 6633579,
"order": 18,
"name": "Additional Comments",
"type": "comment",
"rating": "",
"comment": "",
"published": false
... truncated ...
],
"links": {
"first": "https://www.guildquality.com/company-api/v3/surveys?page=1",
"last": "https://www.guildquality.com/company-api/v3/surveys?page=17",
"prev": "https://www.guildquality.com/company-api/v3/surveys?page=10",
"next": "https://www.guildquality.com/company-api/v3/surveys?page=12"
},
"meta": {
"current_page": 11,
"from": 501,
"last_page": 17,
"path": "https://www.guildquality.com/company-api/v3/surveys",
"per_page": 50,
"to": 550,
"total": 806
}
Get Survey
Returns data for a single survey.
URL
https://www.guildquality.com/company-api/v3/surveys/surveyId
Format
JSON
HTTP Method
GET
Parameters
- Questions
- Description: Return question data included on survey
- Format: To include questions set this parameter to 1. To exclude them, don’t include the parameter or set it to 0.
To include questions set this parameter to 1. To exclude them, don’t include the parameter or set it to 0.
Example data returned:
{
"data": {
"id": 503212,
"contact": {
"id": 496497,
"name": "Bertha Jorgensen",
"email1": "BerthaHJorgensen@rhyta.com",
"email2": "",
"phone1": "(904) 325-9937",
"phone2": ""
},
"project": {
"address": "1390 Kidd Avenue",
"city": "Oliktok",
"state": "AK",
"zip": "99501",
"customFilters": {
"Project Type": [
"Remodel"
],
"Warranty Type": [
"Diamond"
],
"Remodel Type": [
"Bathroom"
},
"template": "",
"endedAt": "2017-12-26T21:48:48 EST",
"completionMode": "phone",
"questions": [
"id": 6633562,
"order": 1,
"name": "Likely To Recommend",
"type": "both",
"rating": 5,
"comment": "I was very satisfied with the quality of the work that was done.",
"published": false
},
"id": 6633563,
"order": 2,
"name": "Clean",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633564,
"order": 3,
"name": "Safe",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633565,
"order": 4,
"name": "Respectful",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633566,
"order": 5,
"name": "Communication",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633567,
"order": 6,
"name": "Quality Of Materials",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633568,
"order": 7,
"name": "Quality Of Workmanship",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633569,
"order": 8,
"name": "Problem Resolution",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633570,
"order": 9,
"name": "Professional & Organized",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633571,
"order": 10,
"name": "Schedule",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633572,
"order": 11,
"name": "Value",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633573,
"order": 12,
"name": "Sales Knowledge",
"type": "both",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633574,
"order": 13,
"name": "Recognized Excellence",
"type": "comment",
"rating": "",
"comment": "I would recognize the salesperson for their exceptional service.",
"published": false
},
"id": 6633575,
"order": 14,
"name": "Areas For Improvement",
"type": "comment",
"rating": "",
"comment": "",
"published": false
},
"id": 6633576,
"order": 15,
"name": "Areas Of Satisfaction",
"type": "comment",
"rating": "",
"comment": "They met my expectations with the quality of work. It was exceptional.",
"published": false
},
"id": 6633577,
"order": 16,
"name": "Design",
"type": "rating",
"rating": 5,
"comment": "",
"published": false
},
"id": 6633578,
"order": 17,
"name": "Further Needs",
"type": "mcs",
"rating": "",
"comment": "",
"published": false
},
"id": 6633579,
"order": 18,
"name": "Additional Comments",
"type": "comment",
"rating": "",
"comment": "",
"published": false
}
Add Customer
This endpoint allows for the addition of a single customer, their project data and the scheduling of surveys.
The data payload should be transmitted in JSON (application/json) format. A sample payload is listed below. Some things to note:
customFields: The customFields object can store custom data from your application in GuildQuality. These fields must be configured in advance by visiting the “Settings” → “Custom Fields” section of your GuildQuality account.
Users: The users object tags members of your team on the project. You can find a list of users by visiting “Settings” → “Team” in your GuildQuality account.
Surveys: The surveys object defines which, if any surveys, the customer should receive. They are referenced by name and can be found in the “Settings” → “Templates” section of your GuildQuality account.
affiliateCompany: Optional argument to add data to a child account.
firstName and lastName: These two fields will be used if name is not defined.
URL
https://www.guildquality.com/company-api/v3/customer
Format
JSON
HTTP Method
POST
Sample data to POST:
[
{
"email1": "robertmwhite@teleworm.us",
"email2": "",
"name": "Robert White Jr.",
"phone1": "907-245-4609",
"phone2": "",
"affiliateCompany": "Alpha Restoration",
"value": "500000",
"firstName": "JJ",
"lastName": "Clark",
"projects": [
{
"address": "2739 Veltri Drive",
"city": "Anchorage",
"endDate": "6/22/2019",
"externalId": "",
"notes": "",
"startDate": "5/11/2019",
"state": "AK",
"zip": "99502",
"customFields": [
{
"label": "Remodel Type",
"value": "Whole House"
},
{
"label": "Warranty Type",
"value": "Platinum"
}
],
"users": [
{
"firstName": "Philip",
"lastName": "Brower",
"roles": [
{
"name": "Project Manager"
}
]
},
{
"firstName": "Kevin",
"lastName": "Smith",
"roles": [
{
"name": "Team Lead"
}
]
}
],
"projectTags": [
{
"text": "Design build remodel"
},
{
"text": "Exterior upgrades"
}
],
"surveys": [
{
"name": "Full-process smart survey"
},
{
"name": "Warranty Survey"
}
],
"surveyGroups": [
{
"name": "Project surveys"
}
]
}
]
}
]
Sample data returned on successful POST:
Status: 200 OK
Body:
{
"658962": {
"customer_updated": false,
"project_updated": false
}
Get Survey Templates
Returns available survey templates for an account.
URL
https://www.guildquality.com/company-api/v3/survey-templates
Format
Json
HTTP Method
GET
Sample data returned on successful GET:
Status: 200 OK
Body:
{
"data": [
{
"id": 4173,
"name": "Email-only smart survey",
"fullProcess": false,
"schedule": "4 weeks after the project end date",
"smartQuestionsMuted": false
},
{
"id": 4174,
"name": "Full-process smart survey",
"fullProcess": true,
"schedule": "1 day after the project end date",
"smartQuestionsMuted": false
},
{
"id": 4175,
"name": "Prospect survey",
"fullProcess": false,
"schedule": "0 days after the project creation date",
"smartQuestionsMuted": false
},
{
"id": 4238,
"name": "Warranty Survey",
"fullProcess": false,
"schedule": "48 weeks after the project end date",
"smartQuestionsMuted": true
},
{
"id": 4457,
"name": "Prospect Survey Test",
"fullProcess": false,
"schedule": "0 days after the project creation date",
"smartQuestionsMuted": false
},
{
"id": 5063,
"name": "Mid Way Through",
"fullProcess": true,
"schedule": "4 weeks after the project start date",
"smartQuestionsMuted": false
},
{
"id": 5764,
"name": "test",
"fullProcess": false,
"schedule": "4 weeks after the project end date",
"smartQuestionsMuted": false
}
]
}
Get Custom Fields
Returns available custom fields and values for an account.
URL
https://www.guildquality.com/company-api/v3/custom-fields
Format
Json
HTTP Method
GET
Sample data returned on successful GET:
Status: 200 OK
Body:
[
{
"id": 191,
"label": "Project Type",
"values": [
{
"id": 33292,
"value": "Build"
},
{
"id": 33291,
"value": "Remodel"
}
]
},
{
"id": 366,
"label": "Home Plan",
"values": [
{
"id": 33296,
"value": "The Adams"
},
{
"id": 33299,
"value": "The Alexander"
},
{
"id": 33298,
"value": "The Dailey"
},
{
"id": 33301,
"value": "The Huston"
}
]
},
{
"id": 368,
"label": "Remodel Type",
"values": [
{
"id": 33300,
"value": "Addition"
},
{
"id": 33302,
"value": "Bathroom"
},
{
"id": 33304,
"value": "Family Room"
},
{
"id": 33297,
"value": "Kitchen"
},
{
"id": 33303,
"value": "Whole House"
}
]
}
]
Get Team Members
Returns team members defined in an account.
URL
https://www.guildquality.com/company-api/v3/team
Format
Json
HTTP Method
GET
Sample data returned on successful GET:
Status: 200 OK
Body:
{
"data": [
{
"id": 88324,
"role": "Read",
"name": "Curtis Greene",
"email": "curtis@lorembuildremodel.com",
"avatarUrl": "https://gq-photos.s3.amazonaws.com/avatar/88324-1550696632"
},
{
"id": 88325,
"role": "Crew",
"name": "Kevin Smith",
"email": "kevin@lorembuildremodel.com",
"avatarUrl": "https://gq-photos.s3.amazonaws.com/avatar/88325-1550696690"
},
{
"id": 88329,
"role": "Read",
"name": "Marco Ruiz",
"email": "marco@lorembuildremodel.com",
"avatarUrl": "https://gq-photos.s3.amazonaws.com/avatar/88329-1550699133"
},
{
"id": 88322,
"role": "Owner",
"name": "Mark Whilberg",
"email": "mark@lorembuildremodel.com",
"avatarUrl": "https://gq-photos.s3.amazonaws.com/avatar/88322-1550696467"
},
{
"id": 88323,
"role": "Admin",
"name": "Philip Brower",
"email": "philip@lorembuildremodel.com",
"avatarUrl": "https://gq-photos.s3.amazonaws.com/avatar/88323-1550696567"
},
{
"id": 88327,
"role": "Admin",
"name": "Staci Miller",
"email": "staci@lorembuildremodel.com",
"avatarUrl": "https://gq-photos.s3.amazonaws.com/avatar/88327-1550697019"
}
]
}
Get Company Children
Returns child accounts for a given account.
URL
https://www.guildquality.com/company-api/v3/children
Format
Json
HTTP Method
GET
Sample data returned on successful GET:
Status: 200 OK
{
"data": [
{
"id": 908534,
"name": "Alpha Construction,
"typeId": 3,
"urlSegment": "Alpha-Construction",
"createdAt": "2017-01-10T23:23:39-05:00"
},
{
"id": 403593,
"name": "24-7 Restorations",
"typeId": 3,
"urlSegment": "24-7-Restorations",
"createdAt": "2019-06-21T17:16:58-04:00"
},
{
"id": 796431,
"name": "Master Craftz",
"typeId": 3,
"urlSegment": "Master-Craftz",
"createdAt": "2019-09-05T15:43:39-04:00"
}
]
}