Field Nation Integration Documentation

URLs

Environment	Method	URL
Sandbox		https://api-sandbox.fndev.net/api/rest/v2/clients
Production		https://api.fieldnation.com/api/rest/v2/clients

Path Parameters

Not applicable.

Query Parameters

Refer to Pagination for a list of additional query parameters.

Parameter	Type	Example	Notes
access_token	string	abc123defg459hijk786lmn45	Required.
columns	boolean	&columns=name,projects	Specify columns. Optional. Columns active, address_1, address_2, city, state, zip, country, created, id, location_type, name, policy_procedure, print_logo, standard_instruction, website

Body

Not applicable.

Response

You can locate client details in the Response > results object. results will vary depending on your query parameters. In the examples below, the Response has been trimmed to display only the results.

Refer to Pagination for more information.

Examples

Get Client IDs

https://URL/clients?access_token=abc123defg459hijk786lmn45


"results":[
   {
      "id":188
   },
   {
      "id":187
   }
]

Get Client ID, Name, and Status

https://URL/clients?access_token=abc123defg459hijk786lmn45&columns=name, active


"results":[
   {
      "id":188,
      "name":"Main Street Shipping",
      "active":true
   },
   {
      "id":189,
      "name":"Repair, Inc",
      "active":false
   },
   {
      "id":187,
      "name":"Tech Corp",
      "active":true
   }
]

Get Client Projects

https://URLclients?access_token=abc123defg459hijk786lmn45&columns=projects

Project information is located in the project > results object for each client.


"results":[
   {
      "id":188,
      "projects":{
         "metadata":{
            "total":1,
            "pages":1,
            "per_page":1,
            "page":1
         },
         "results":[
            {
               "id":239,
               "name":"Monthly Copier Maintenance",
               "status":"active"
            }
         ],
         "actions":[
            "add"
         ]
      }
   },
   {
      "id":189,
      "projects":{
         "metadata":{
            "total":0,
            "pages":1,
            "per_page":0,
            "page":1
         },
         "results":[

         ],
         "actions":[
            "add"
         ]
      }
   },
   {
      "id":187,
      "projects":{
         "metadata":{
            "total":1,
            "pages":1,
            "per_page":1,
            "page":1
         },
         "results":[
            {
               "id":238,
               "name":"Alarm System Upgrade",
               "status":"active"
            }
         ],
         "actions":[
            "add"
         ]
      }
   }
]

Errors

Standard HTTP and OAuth error codes.