API Fields (Developer)

Common use-cases include:

Pulling in Site Codes from your facility database
Pulling in Customer contact names from your CRM
Pulling in Product/Service Names from your product database

Data Format

The data format required for API fields is JSON format, and there are 2 schemas available: Basic and Complex.

Basic Format

The basic format is the fastest and easiest to setup.

{
  "results": [
    {
      "id": "plqa-daniel@mailinator.com",
      "text": "plqa-daniel@mailinator.com"
    },
    {
      "id": "plqa-meridith@mailinator.com",
      "text": "plqa-meridith@mailinator.com"
    },
    {
      "id": "plqa-amy@mailinator.com",
      "text": "plqa-amy@mailinator.com"
    }
  ]
}

Test it with our sample data source: https://www.pipelineapp.io/dropdownapi-basic.json

Complex Format

The complex data format gives you the ability to categorize items:

View Sample JSON Payload

{
  "results": [
    {
      "text": "Administrators",
      "children": [
        {
          "id": "plqa-amy@mailinator.com",
          "text": "plqa-amy@mailinator.com"
        },
        {
          "id": "plqa-greg@mailinator.com",
          "text": "plqa-greg@mailinator.com"
        }
      ]
    },
    {
      "text": "Testers",
      "children": [
        {
          "id": "plqa-daniel@mailinator.com",
          "text": "plqa-daniel@mailinator.com"
        },
        {
          "id": "plqa-meridith@mailinator.com",
          "text": "plqa-meridith@mailinator.com"
        }
      ]
    }
  ]
}

Test it with our sample data source: https://www.pipelineapp.io/dropdownapi-complex.json