---
updatedAt: 2026-06-12T14:08:37.000Z
agentTools:
  projectIndex: https://developer.crunchtime.com/llms.txt
---

# Get getUdaVendors

Retrieve a list of UDA vendors.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger documentation supporting mobile development of Crunchtime.",
    "version": "2.99",
    "title": "Inventory & Labor",
    "termsOfService": "http://springfox.io",
    "contact": {
      "name": "Crunchtime Development Team",
      "url": "http://www.crunchtime.com",
      "email": "apiquestions@crunchtime.com"
    },
    "license": {
      "name": "Apache License Version 2.0",
      "url": "https://github.com/springfox/springfox/blob/master/LICENSE"
    }
  },
  "tags": [
    {
      "name": "Uda Service",
      "description": "The User Defined Attributes (UDA) Service allows for the retrieval of the location and vendor User-Defined Attributes (UDAs). Location UDAs can be configured at the corporate level or specific to a particular location."
    }
  ],
  "paths": {
    "/uda/v1/vendors/list": {
      "get": {
        "tags": [
          "Uda Service"
        ],
        "summary": "Get getUdaVendors",
        "description": "Retrieve a list of UDA vendors.",
        "operationId": "getUdaVendorsUsingGET",
        "parameters": [
          {
            "name": "activeFlag",
            "in": "header",
            "description": "Use `true` to retrieve active UDA vendors.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "authenticationtoken",
            "in": "header",
            "description": "Secure token for API authentication.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "minutesSinceUpdate",
            "in": "query",
            "description": "The number of minutes since a vendor record was last updated. Use to set how far back to search.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "password",
            "in": "header",
            "description": "Password for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sitename",
            "in": "header",
            "description": "Crunchtime site identifier. (test or production)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userid",
            "in": "header",
            "description": "User ID for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-B3-TraceId",
            "in": "header",
            "description": "Optional trace identifier for troubleshooting.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeNull",
            "in": "query",
            "description": "Specify 'true' to output null data elements.",
            "required": false,
            "allowEmptyValue": true,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/BaseVendorDto"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BaseVendorDto"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authorization",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "503": {
            "description": "System under maintenance",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "504": {
            "description": "Timeout",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "description": "Crunchtime Developer Hub",
    "url": "https://developer.crunchtime.com/"
  },
  "servers": [
    {
      "url": "//webservices-test.net-chef.com"
    }
  ],
  "components": {
    "schemas": {
      "BaseVendorDto": {
        "type": "object",
        "properties": {
          "supplyCode": {
            "type": "string"
          },
          "supplyId": {
            "type": "integer",
            "format": "int64"
          },
          "supplyName": {
            "type": "string"
          },
          "vendorUdaDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BaseVendorUdaDetailDto"
            }
          }
        },
        "title": "BaseVendorDto"
      },
      "BaseVendorUdaDetailDto": {
        "type": "object",
        "properties": {
          "dataType": {
            "type": "string"
          },
          "lastTouchDate": {
            "type": "string",
            "format": "date-time"
          },
          "replicatedFlag": {
            "type": "string"
          },
          "requiredFlag": {
            "type": "string"
          },
          "supplyCode": {
            "type": "string"
          },
          "supplyId": {
            "type": "integer",
            "format": "int64"
          },
          "udaCode": {
            "type": "string"
          },
          "udaDescription": {
            "type": "string"
          },
          "udaGroup": {
            "type": "string"
          },
          "udaType": {
            "type": "string"
          },
          "udaValue": {
            "type": "string"
          }
        },
        "title": "BaseVendorUdaDetailDto"
      },
      "ObjectError": {
        "type": "object",
        "properties": {
          "arguments": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "code": {
            "type": "string"
          },
          "codes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "defaultMessage": {
            "type": "string"
          },
          "objectName": {
            "type": "string"
          }
        },
        "title": "ObjectError"
      }
    }
  }
}
```