Get Vendors

gethttps://api.flxpoint.com/vendors

Use this when you want to pull vendor data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Endpoint to retrieve back a list of Vendors.

Requires Account-level privileges.

Request

Example request

get/vendors

curl -X GET "https://api.flxpoint.com/vendors" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json

array[Vendor]

idinteger

The ID of the Vendor

createdByUserIdinteger

When a Vendor is created in-app, a `User` ID is tracked.

createdAtstring (date-time)

Timestamp of when the Vendor was created.

deletedAtstring (date-time)

Timestamp of when the Vendor was deleted/archived.

namestring

descriptionstring

portalEnabledboolean

This flag determines if the Vendor can access a Vendor Portal to manually interact with Inventory/PO flows. If this flag is `true` - there is still a requirement to ensure you have a portal configured. To configure a Vendor Portal, you have to setup a subdomain such as : `example.vendors.flxpoint.com` You can either do this via the UI (feature launching in late 2021) or via a ticket to our Support Team.

Example response

[
  {
    "id": 0,
    "createdByUserId": 0,
    "createdAt": "2026-04-20T00:00:00Z",
    "deletedAt": "2026-04-20T00:00:00Z",
    "name": "string",
    "description": "string",
    "portalEnabled": true
  }
]

401Unauthorized

No schema documented for this status.

OpenAPI fragment

{
  "get": {
    "summary": "Get Vendors",
    "description": "Endpoint to retrieve back a list of Vendors. \n\nRequires Account-level privileges. ",
    "parameters": [],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Vendor"
              }
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight