GET
/
ext
/
v1
/
vendors
List vendors
curl --request GET \
  --url https://api.light.inc/rest/ext/v1/vendors
{
  "total": 123,
  "records": [
    {
      "type": "EXTERNAL",
      "vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyEntityIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "defaultCompanyEntity": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "costCenterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "senderBankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "vatId": "<string>",
      "identifier": "<string>",
      "name": "<string>",
      "description": "<string>",
      "avatarUrl": "<string>",
      "email": "<string>",
      "phoneNumber": {
        "countryCode": "UNDEFINED",
        "localNumber": "<string>"
      },
      "website": "<string>",
      "country": "UNDEFINED",
      "city": "<string>",
      "address": "<string>",
      "zipcode": "<string>",
      "bankName": "<string>",
      "bankCountry": "UNDEFINED",
      "bankCity": "<string>",
      "bankAddress": "<string>",
      "bankZipcode": "<string>",
      "bankAccountNumber": "<string>",
      "bankAccountBic": "<string>",
      "domesticBankAccountNumber": "<string>",
      "domesticBankAccountCode": "<string>",
      "swedishBankgiroNumber": "<string>",
      "vendorCreatedAt": "2023-11-07T05:31:56Z",
      "approvers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "priority": 123,
          "createdAt": "2023-11-07T05:31:56Z"
        }
      ],
      "notes": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "authorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "channel": "WEB_APP",
          "content": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "currency": "USD",
      "contractValue": 123,
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "ONBOARDING",
      "failureContext": {
        "type": "BAD_REQUEST",
        "errors": [
          {
            "type": "<string>",
            "clientMessage": "<string>",
            "message": "<string>",
            "path": [
              "<string>"
            ],
            "context": {}
          }
        ],
        "stackTrace": [
          {
            "classLoaderName": "<string>",
            "moduleName": "<string>",
            "moduleVersion": "<string>",
            "methodName": "<string>",
            "fileName": "<string>",
            "lineNumber": 123,
            "nativeMethod": true,
            "className": "<string>"
          }
        ],
        "message": "<string>",
        "suppressed": [
          {
            "stackTrace": [
              {
                "classLoaderName": "<string>",
                "moduleName": "<string>",
                "moduleVersion": "<string>",
                "methodName": "<string>",
                "fileName": "<string>",
                "lineNumber": 123,
                "nativeMethod": true,
                "className": "<string>"
              }
            ],
            "message": "<string>",
            "localizedMessage": "<string>"
          }
        ],
        "localizedMessage": "<string>",
        "name": "<string>"
      },
      "version": 123,
      "updatedAt": "2023-11-07T05:31:56Z",
      "customProperties": [
        {
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "values": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "groupInternalName": "<string>",
              "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "internalName": "<string>",
              "label": "<string>",
              "context": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    }
  ]
}

Query Parameters

​
sort
string
Example:

"amount:desc,createdAt:asc"

​
filter
string
Example:

"state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500"

​
searchTerm
string
​
limit
integer
​
offset
integer

Response

default - application/json;charset=UTF-8

default response

The response is of type object.