/crm/external/v1/queue/fields

Queue Fields information from Administration > Queues > Fields tab

Parameters

  • TenantID - How your specific customer instance is identified, this will be a number. Find this in the app Help (?) icon > MotionCX Voice > Tenant:
  • QueueID - Numeric ID for queues can be found Administration > Queues
  • It is recommended advanced filter object be done outside of the API document for best results.

Responses available:

  • 200
  • 401
  • 403

Example return:

[
  {
    "required": false,
    "ordering": 1,
    "field": {
      "id": 1075,
      "tenantId": 2,
      "name": "Order Number",
      "hint": null,
      "searchable": true,
      "isDisabled": false,
      "type": {
        "id": 9,
        "type": "number",
        "hasOptions": false
      },
      "options": [],
      "isShownInPublic": true
    },
    "requiredForStatus": []
  },
  {
    "required": false,
    "ordering": 2,
    "field": {
      "id": 1077,
      "tenantId": 2,
      "name": "Conditional Test",
      "hint": null,
      "searchable": false,
      "isDisabled": false,
      "type": {
        "id": 4,
        "type": "radio",
        "hasOptions": true
      },
      "options": [
        {
          "fieldId": 1077,
          "value": "No",
          "isConditional": false,
          "fieldOptionFields": []
        },
        {
          "fieldId": 1077,
          "value": "Yes",
          "isConditional": true,
          "fieldOptionFields": [
            {
              "childFieldId": 1078,
              "required": false,
              "ordering": 1,
              "field": {
                "id": 1078,
                "tenantId": 2,
                "name": "Conditional Display",
                "hint": null,
                "searchable": false,
                "isDisabled": false,
                "type": {
                  "id": 1,
                  "type": "text",
                  "hasOptions": false
                },
                "options": [],
                "isShownInPublic": true
              }
            }
          ]
        }
      ],
      "isShownInPublic": true
    },
    "requiredForStatus": []
  },
  {
    "required": true,
    "ordering": 3,
    "field": {
      "id": 1079,
      "tenantId": 2,
      "name": "Conditional Select Test",
      "hint": null,
      "searchable": false,
      "isDisabled": false,
      "type": {
        "id": 3,
        "type": "select",
        "hasOptions": true
      },
      "options": [
        {
          "fieldId": 1079,
          "value": "No",
          "isConditional": false,
          "fieldOptionFields": []
        },
        {
          "fieldId": 1079,
          "value": "Yes",
          "isConditional": true,
          "fieldOptionFields": [
            {
              "childFieldId": 1078,
              "required": false,
              "ordering": 1,
              "field": {
                "id": 1078,
                "tenantId": 2,
                "name": "Conditional Display",
                "hint": null,
                "searchable": false,
                "isDisabled": false,
                "type": {
                  "id": 1,
                  "type": "text",
                  "hasOptions": false
                },
                "options": [],
                "isShownInPublic": true
              }
            }
          ]
        }
      ],
      "isShownInPublic": true
    },
    "requiredForStatus": []
  },
  {
    "required": true,
    "ordering": 10000,
    "field": {
      "id": 1080,
      "tenantId": 2,
      "name": "Checkbox Test",
      "hint": null,
      "searchable": false,
      "isDisabled": false,
      "type": {
        "id": 5,
        "type": "checkbox",
        "hasOptions": true
      },
      "options": [],
      "isShownInPublic": false
    },
    "requiredForStatus": []
  }
]
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!