Endpoint is used to export your forms from Repsly. System limit is 50 rows..

More Info

In every response you will receive meta variables FirstID and LastID. Save LastID for future requests so you can use it as a parameter {lastFormID} for every subsequent request until the response meta variable TotalCount is equal to 0, which means you have received all updates.

To get the complete list of forms, start your request with parameter {lastFormID} = 0.

Response definition

MetaCollectionResult\TotalCountIntegerTotal count of forms
MetaCollectionResult\FirstIDIntegerUnique ID of the first item in the list
MetaCollectionResult\LastIDIntegerUnique ID of the last item in the list
FormIDIntegerUnique form ID
FormNameString (255)Name of the form
ClientCodeString (50)Unique client code
ClientNameString (255)Client name
DateAndTimeDatetimeDate and time of creation of this form
RepresentativeCodeString (20)Unique representative code (author of this form)
RepresentativeNameString (80)Representative name (author of this form)
StreetAddressString (255)Client street address
ZIPString (20)Client ZIP code
ZIPExtString (20)Client ZIP extension
CityString (255)Client city
StateString (255)Client state
CountryString (255)Client country
EmailString (255)Client email address
PhoneString (128)Client phone number
MobileString (128)Client mobile phone number
TerritoryString (80)Territory name this client belongs to
SignatureURLString (512)Signature image URL
VisitStartDatetimeDate and time of visit start
VisitEndDatetimeDate and time of visit end
Item\FieldString (255)Custom field name
Item\ValueTextCustom field value
VisitIDIntegerUnique Visit ID

Form questions and answers

The 'Items' field in the response is an ordered list of key/value pairs. In each pair, the 'Field' is the verbatim question from the Form, and the 'Value' is the answer. Form questions may be set up to be one of several types (see below); however, the API always returns a text value. Note that if the question is changed in a Form template, the questions in the already-filled Forms do not change.

The response to a Selection-type question may conditionally point to another group of questions. If the condition is met, the question group will appear inserted into the list of question/answers right after the Selection.

All direct questions in a Form will always appear in the 'Items' list; if they were not answered, the 'Value' will be "" (an empty string). However, conditional questions that were not invoked will not appear in the list.

Question types and example responses

TypeExample response
Short text"This is the answer "
Long text"Lorem ipsum dolor sit amet.\nConsectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Feugiat nibh sed pulvinar proin gravida hendrerit lectus. Purus faucibus ornare suspendisse sed ni"
Multiple selection"California | New York"
Photo"https://repsly.s3.amazonaws.com/c71d5df8-52ff-4378-bcc6-729fcf2eb92c.jpg?AWSAccessKeyId=AKIAJNLZVQDKWR6HJR6A&Expires=2147472000&Signature=8fktruZesRDAxv31Qmcm7bkeQag%3D "
Multiple photos"https://repsly.s3.amazonaws.com/af528443-9dfb-42dc-8b9e-ab8f28a00b8e.jpg | https://repsly.s3.amazonaws.com/97393f2d-8dd4-43ca-a879-1659d7f771be.jpg | https://repsly.s3.amazonaws.com/29262909-d7ab-42cc-bbca-d7e560ceac9a.jpg | https://repsly.s3.amazonaws.com/6b9ecab0-3296-4203-8390-33d015ec85fe.jpg | https://repsly.s3.amazonaws.com/d272beb9-b329-4091-b16d-eaa984ba8bb7.jpg"
Section header""
Product"12345678900 Heinz Mustard"