Get Source
https://api.flxpoint.com/source/{id}Use this when you want to pull source data through the API.
This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.
Retrieves back a Source by it's ID.
This endpoint requires : - Account level Privileges - OR Source specific Privileges
Request
includeAddressquerybooleanDetermines if "address" is returned in the response.
default falseincludeVendorquerybooleanDetermines if "vendor" is returned in the response.
default falseincludeIntegrationsquerybooleanDetermines if "integrations" is returned in the response.
default falseincludeSettingsquerybooleanSet this to `true` to return back the `settings` on the Source. This will include all available settings and not just those that have already been configured.
default false
Example request
/source/{id}curl -X GET "https://api.flxpoint.com/source/{id}" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN"Responses
200OKapplication/json
idintegerrequirednamestringdescriptionstringinsertedAtstring (date-time)addressIdintegerrateShoppingbooleanreleaseCommittedStockOnShipmentAddedbooleandeprecatedreleaseCommittedStockOnQuantityUpdatebooleandeprecatedvendorIdintegertypeobjectidintegernamestringData SourceInternal WarehouseExternal WarehouseVendor Warehousehandlestringdata_sourceinternal_warehouseexternal_warehousevendor_warehousecurrencyobjectidintegerrequiredcodestringrequirednamestringsymbolstringunicodeDecimalstringaddressobjectidintegernamestringaddressLine1stringaddressLine2stringcitystringstatestringcountrystringstateCodestringcountryCodestringpostalstringemailstringphonestringcompanyNamestringfirstNamestringlastNamestringredactedbooleanhashstringcommitStockbooleanallowBackordersbooleanvendorobjectidintegercreatedByUserIdintegercreatedAtstring (date-time)deletedAtstring (date-time)namestringdescriptionstringportalEnabledbooleancontainsFirearmsWorkflowEventIdintegercontainsFirearmsbooleanshippingCostWorkflowEventIdintegerdropshipFeeWorkflowEventIdintegerintegrationsarray[any]settingsarray[SourceSetting]idintegerrequiredsettingobjectrequiredidintegernamestringrequiredhandlestringrequiredtypestringrequiredimgbooleantime_interval_thresholdemailstringtextselectnumberradiomultijsonvalueTypestringrequiredintegerbooleantime_interval_thresholdstringselectemaildecimalnumbermultijsonplaceholderstringdefaultValuestringdescriptionstringoptionsstringparentSettingIdintegercategoryobjectidintegerhandlestringsupplier.settingsdealer.invoice.settingsaccount.settingsnotificationsaccount.b2bchannel.settingsfeature_flagsdealer.channel.settingssource.settingsvendor.settingsnamestringsourceIdintegervaluestringrequiredinsertedAtstring (date-time)updatedAtstring (date-time)autoCreateListingsWorkflowEventIdintegerautoRebuildEnabledOnstring (date-time)autoRebuildConfirmedByUserstringautoListEnabledOnstring (date-time)autoListConfirmedByUserstringautoCreateListingsForAllInventoriesbooleanautoCreateListingsForSpecificInventoriesbooleanautoGenerateInvoiceWorkflowIdinteger{
"id": 0,
"name": "string",
"description": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"addressId": 0,
"rateShopping": true,
"releaseCommittedStockOnShipmentAdded": true,
"releaseCommittedStockOnQuantityUpdate": true,
"vendorId": 0,
"type": {
"id": 0,
"name": "Data Source",
"handle": "data_source"
},
"currency": {
"id": 0,
"code": "string",
"name": "string",
"symbol": "string",
"unicodeDecimal": "string"
},
"address": {
"id": 0,
"name": "Joe Smith",
"addressLine1": "120 1st Lane",
"addressLine2": "Suite 123",
"city": "Jacksonville",
"state": "Florida",
"country": "United States",
"stateCode": "FL",
"countryCode": "US",
"postal": "12345",
"email": "person@example.com",
"phone": "1-555-123-4567",
"companyName": "string",
"firstName": "Joe",
"lastName": "Smith",
"redacted": true,
"hash": "string"
},
"commitStock": true,
"allowBackorders": true,
"vendor": {
"id": 0,
"createdByUserId": 0,
"createdAt": "2026-04-20T00:00:00Z",
"deletedAt": "2026-04-20T00:00:00Z",
"name": "string",
"description": "string",
"portalEnabled": true
},
"containsFirearmsWorkflowEventId": 0,
"containsFirearms": true,
"shippingCostWorkflowEventId": 0,
"dropshipFeeWorkflowEventId": 0,
"integrations": [
null
],
"settings": [
{
"id": 0,
"setting": {
"id": 0,
"name": "string",
"handle": "string",
"type": "img",
"valueType": "integer",
"placeholder": "string",
"defaultValue": "string",
"description": "string",
"options": "string",
"parentSettingId": 0,
"category": {
"id": null,
"handle": null,
"name": null
}
},
"sourceId": 0,
"value": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z"
}
],
"autoCreateListingsWorkflowEventId": 0,
"autoRebuildEnabledOn": "2026-04-20T00:00:00Z",
"autoRebuildConfirmedByUser": "string",
"autoListEnabledOn": "2026-04-20T00:00:00Z",
"autoListConfirmedByUser": "string",
"autoCreateListingsForAllInventories": true,
"autoCreateListingsForSpecificInventories": true,
"autoGenerateInvoiceWorkflowId": 0
}401Unauthorized
No schema documented for this status.
404Not Found
No schema documented for this status.
OpenAPI fragment
{
"get": {
"summary": "Get Source",
"description": "Retrieves back a Source by it's ID. \n\nThis endpoint requires : \n- Account level Privileges\n- OR Source specific Privileges",
"parameters": [
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeAddress",
"description": "Determines if \"address\" is returned in the response."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeVendor",
"description": "Determines if \"vendor\" is returned in the response."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeIntegrations",
"description": "Determines if \"integrations\" is returned in the response."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeSettings",
"description": "Set this to `true` to return back the `settings` on the Source. This will include all available settings and not just those that have already been configured."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Source"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not Found"
}
}
}
}