--header 'Authorization: Bearer [token]'

"headers": {"Authorization": "Bearer [token]"}

headers = {'Authorization': 'Bearer [token]'}

httpURLConnection.setRequestProperty("Authorization", "Bearer [token]");

httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", [token]);

[
{
"key": "abc123",
"code": "acmeinc",
"administrator": {
"email": "me@me.com",
"firstName": "Bob",
"lastName": "Smith",
"workPhone": "1111111111"
},
"branded": true,
"credits": 10,
"licenses": 1,
"name": "Acme Inc Corp Ltd Pty",
"plan": {
"code": "pre02",
"name": "Premium"
},
"status": "Paid",
"active": true
},
{
"key": "abc124",
"code": "democo",
"administrator": {
"email": "me@me.com",
"firstName": "Bob",
"lastName": "Smith Jr",
"workPhone": "+5551231234"
},
"branded": true,
"credits": 10,
"licenses": 1,
"name": "Test company",
"plan": {
"code": "dem02",
"name": "Demo"
},
"status": "Canceled",
"active": false
}
]

Query customer accounts.

Requires reseller authentication.

• Possible query fields:

  • administrator.email

{
"key": "abc123",
"code": "acmeinc",
"administrator": {
"email": "me@me.com",
"firstName": "Bob",
"lastName": "Smith",
"workPhone": "1111111111"
},
"branded": true,
"credits": 10,
"licenses": 1,
"name": "Acme Inc Corp Ltd Pty",
"plan": {
"code": "pre02",
"name": "Premium"
},
"status": "Paid",
"active": true
}

Returns information about the current account.

• Requires user authentication.

{
"key": "abc123",
"code": "acmeinc",
"administrator": {
"email": "me@me.com",
"firstName": "Bob",
"lastName": "Smith",
"workPhone": "1111111111"
},
"branded": true,
"credits": 10,
"licenses": 1,
"name": "Acme Inc Corp Ltd Pty",
"plan": {
"code": "pre02",
"name": "Premium"
},
"status": "Paid",
"active": true
}

Get the account. 

• Requires reseller authentication.

{
"active": true
}

Update the account.

• active - Set to true to activate the account, false to deactivate the account. Requires reseller token authentication.

• requires reseller authentication.

[
{
"key": "act124",
"submissionKey": "abc123",
"projectKey": "pqr123",
"formKey": "fgh123",
"receiveTime": "2019-08-20T15:35:19.139-04:00",
"type": "update",
"submissionId": "acme$$12345$$Published&&1",
"submissionName": "My name | 3",
"projectName": "Main Project",
"formName": "First Form v1",
"userId": "me@me.com",
"userName": "My Name"
},
{
"key": "act123",
"submissionKey": "abc123",
"projectKey": "pqr123",
"formKey": "fgh123",
"receiveTime": "2019-08-20T14:38:54.896-04:00",
"type": "new",
"submissionId": "acme$$12345$$Published&&1",
"submissionName": "My name | 3",
"projectName": "Main Project",
"formName": "First Form v1",
"userId": "5551231234",
"userName": "Device one"
}
]

Returns all submission activity the user has access to.

• Required query parameters:

  • @beginTime - ISO formatted date/time inclusive

  • @endTime - ISO formatted date/time exclusive

• Requires user authentication.

• To query activity by device, form or project, see the these endpoints:

  • GET /devices/{key or number}/activity?

  • GET /forms/{key or id}/activity?

  • GET /projects/{key}/activity?

[
{
"key": "def123",
"name": "Device one",
"email": "me@me.com",
"number": "5551231234",
"teamKey": "tuv123"
},
{
"key": "def234",
"name": "Device two",
"email": "you@you.com",
"number": "5551234321",
"teamKey": "tuv123",
"lastTrack": {
"date": "2018-06-29T11:56:26.000Z",
"offset": -240,
"status": "MOVING",
"position": {
"accuracy": 20.885,
"altitude": 304.899,
"latitude": 34.101222,
"longitude": -84.0015005
},
"velocity": {
"bearing": 31.2198,
"direction": "NNE",
"distance": 489.332,
"speed": 7.6032
}
}
}
]

Returns all devices the user has access to.

• Get a more limited list of devices at /teams/{key}/devices.

• If the device has GPS tracking enabled, the last track received is returned in lastTrack.

• Optional query parameters: latitude, longitude

  • If a device has a lastTrack node, return the distance to the provided latitude and longitude in lastTrack.distanceToTarget.

• Requires user authentication.

{
"key": "def123",
"number": "5551231234",
"name": "Device one",
"email": "me@me.com",
"teamKey": "tuv123"
}

Returns the requested device.

• If number = "Available" the device license has not been assigned to a device.

• Optional query parameters: latitude, longitude

  • If a device has a lastTrack node, return the distance to the provided latitude and longitude in lastTrack.distanceToTarget.

• Requires user authentication.

[
{
"key": "act123",
"submissionKey": "abc123",
"projectKey": "pqr123",
"formKey": "fgh123",
"receiveTime": "2019-08-20T14:38:54.896-04:00",
"type": "new",
"submissionId": "acme$$12345$$Published&&1",
"submissionName": "My name | 3",
"projectName": "Main Project",
"formName": "First Form v1",
"userId": "5551231234",
"userName": "Device one"
}
]

Returns all submission activity for a device that the user has access to.

• Required query parameters:

  • @beginTime - ISO formatted date/time inclusive

  • @endDate - ISO formatted date/time exclusive

• Requires user authentication.

• To query all activity, see the /activity? endpoint.

{
  "ownerId": "5551231234",
"fields": [
{ "name": "Name",
"text": "My name"
},
{ "name": "Choose",
"text": "3"
},
{ "name": "Today_s_date",
"date": "2019-08-19"
},
{ "name": "Number",
"integer": 25
},
{ "name": "Customer_Table",
"rows": [
{"fields": [
{ "name": "Customer_ID",
"text": "32-151"
},
{ "name": "Customer_name",
"text": "ABC Companies"
}]},
{"fields": [
{ "name": "Customer_name",
"text": "Global Industries"
},
{ "name": "Customer_ID",
"text": "44-158"
}]
}]
}
}]
}

Add a new dispatch.

• ownerId - (optional) Set the mobile number to receive the dispatch. If no mobile number is assigned, the dispatch will be set to Pending status.

• fields - An array of fields to populate. All fields are optional.

  • Follow the structure of fields and rows of the form as retrieved from /dispatches/{key} or /submissions/{key}.

  • Only the "name" and the value properties ("text", "integer", "date", etc.) are required for each field.

• Requires webservice authentication.

{
"code": 200,
"key": "rst123",
"ownerKey": "def123",
"status": "Sent"
}

• code - 200 for success.

• key - The key of the dispatch. Retrieve the full dispatch at /dispatches/{key}.

• ownerKey - The key of the device that will receive the dispatch if the ownerId field was populated.

• status - Either "Sent" or "Pending"

{
"code": 401,
"message": "HTTP 401 Unauthorized"
}

• code - The HTTP code of the error.

• message - The error message.

[
{
"key": "rst123",
"id": "acme$$12345$$Published&&1"
},
{
"key": "rst124",
"id": "acme$$12345$$Published&&2"
}
]

Returns dispatch identifiers that match a query.

See /submissions? for more details.

• Requires user or webservice authentication.

200 OK

Delete a dispatch.

• Any related submission can be deleted at /submissions/{key or id}.

• Requires user or webservice authentication.

{ "key": "abc123",
  "id": "acme$$12345$$Published&&1",
  "name": "My name | 3",
  "type": "dispatch",
  "formKey": "fgh123",
  "formName": "First Form v1",
  "formVersion": 1.0,
  "offset": -240,
  "ownerId": "5551231234",
  "ownerName": "Device one",
  "ownerType": "device",
  "projectKey": "pqr123",
  "receiveTime": "2019-08-20T14:38:54.896-04:00",
  "sourceId": "me@me.com",
  "sourceName": "My Name",
  "sourceType": "user",
  "status": "On site",
  "statusTime": "2019-08-20T15:30:24.052-04:00",
  "systemStatus":"Viewed",  "timezone": "Eastern Daylight Time",  "updateTime": "2019-08-20T15:35:19.139-04:00",  "updateUser": "me@me.com",   "fields": [    { "name": "Name",      "data": "text",      "type": "text",      "text": "My name"     },    { "name": "Choose",      "data": "text",      "type": "choose_one",      "text": "3"    },    { "name": "Form_Title",      "data": "text",      "type": "label",      "text": "Form_Title"    },    { "name": "Today_s_date",      "data": "date",      "type": "date_time",      "date": "2019-08-19T00:00:00.000Z"    },    { "name": "Number",      "data": "integer",      "type": "numeric",      "integer": 25    },    { "name": "Customer_Table",      "data": "rows",      "type": "table",      "rows": [        { "index": 0,           "fields": [            { "name": "Customer_ID",              "data": "text",              "type": "lookup",              "text": "32-151"            },            { "name": "Customer_name",              "data": "text",              "type": "text",              "text": "ABC Companies"            } ]        },        { "index": 1,          "fields": [            { "name": "Customer_name",              "data": "text",              "type": "text",              "text": "Global Industries"            },            { "name": "Customer_ID",              "data": "text",              "type": "lookup",              "text": "44-158"            } ]        } ]    }}