1. Resources
    2. arrow-right
  2. Connections

Connections

Connections configured within ItemPath settings link ItemPath to Power Pick or external systems like an ERP. This connection information is available through the API.

Attributes

  • id uuid

    Unique identifier of the connection.

  • appID integer

    Identifier of the parent app.

  • name string

    Name of the connection.

  • url string

    Address of the connection.

  • passwordExists boolean

    True when a password value exits.

  • tokenExists boolean

    True when a token value exits.

  • isTestable boolean

    True when this connection type supports test endpoint checks.

  • authentication string

    Authentication mode used by the connection.

  • type string

    Connection type.

  • username string

    Username for the connection credentials.

  • status integer

    Connection status flag (commonly 0/1).

  • lastestConnection dateTime

    Datetime of the latest successful/disconnect-tracked connection event.

  • creationDate dateTime

    Datetime when the connection record was created.

  • latestLog

    Most recent associated log entry (nested object) if present.

  • lastCheck dateTime

    The datetime of the latest connection test/check.

  • integrationCount dateTime

    Datetime of the latest connection test/check.

Endpoints

Show Connection api/connections/{id}
get

Get info from a specific connection point configured within ItemPath and return a JSON response.

Request with curl
curl "http://[subdomain.itempath.com or IP]api/connections/{id}" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" 
						-d 'GET /api/connections/{id}'
Example Response 
						{
	"id": 1,
	"appId": 2,
	"name": "PowerPick",
	"url": "https://warehouse.example.com",
	"passwordExists": true,
	"tokenExists": false,
	"isTestable": true,
	"authentication": "Basic Authentication",
	"type": "MSSQL",
	"username": "warehouse_user",
	"status": 1,
	"latestConnection": "2026-05-07T13:30:00.602998",
	"creationDate": "2026-05-01T10:12:45.000000",
	"latestLog": {
		"id": 10,
		"creationDate": "2026-05-07T13:30:00.603010",
		"status": 1,
		"description": "Connection test complete",
		"error": null,
		"appId": 2,
		"integrationId": null,
		"workflowId": null,
		"taskId": null,
		"time": 0.42
	},
	"integrationCount": 3,
	"lastCheck": "2026-05-07T13:30:00.603010"
}
List Connections api/connections
get

Get a list of connections from ItemPath. View the guide on adding filters to List API calls.

Body Parameters

  • id integer

    Filter results by connection id.

  • name string

    Filter results by connection name.

  • appId integer

    Filter results by app id.

  • type string

    Filter results by connection type.

  • authentication string

    Filter results by authentication type.

  • countOnly boolean-like string

    When set to `true`, returns only a count object instead of full records.

  • page integer

    Zero-based page index used with `limit` for pagination.

  • limit integer

    Maximum number of records returned per page.

  • orderby string

    Sort expression, optionally with direction (`field` or `field:desc`), supports comma-separated multi-sort.

  • orderBy string

    Case variant alias of `orderby` with identical behavior.

  • OrderBy string

    Case variant alias of `orderby` with identical behavior.

  • Orderby string

    Case variant alias of `orderby` with identical behavior.

Request with curl
curl "http://[subdomain.itempath.com or IP]api/connections" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" 
						-d 'GET /api/connections'
Example Response 
						[
	{
		"id": 1,
		"appId": 2,
		"name": "PowerPick",
		"url": "https://warehouse.example.com",
		"passwordExists": true,
		"tokenExists": false,
		"isTestable": true,
		"authentication": "Basic Authentication",
		"type": "MSSQL",
		"username": "warehouse_user",
		"status": 1,
		"latestConnection": "2026-05-07T13:30:00.602998",
		"creationDate": "2026-05-01T10:12:45.000000",
		"latestLog": {
			"id": 10,
			"creationDate": "2026-05-07T13:30:00.603010",
			"status": 1,
			"description": "Connection test complete",
			"error": null,
			"appId": 2,
			"integrationId": null,
			"workflowId": null,
			"taskId": null,
			"time": 0.42
		},
		"integrationCount": 3,
		"lastCheck": "2026-05-07T13:30:00.603010"
	},
	{
		"id": 2,
		"appId": 2,
		"name": "Web Services",
		"url": "https://api.example.com",
		"passwordExists": false,
		"tokenExists": true,
		"isTestable": true,
		"authentication": "HMAC Authentication",
		"type": "REST",
		"username": "api-user",
		"status": 0,
		"latestConnection": "2026-05-06T08:15:12.120000",
		"creationDate": "2026-05-02T09:00:00.000000",
		"latestLog": null,
		"integrationCount": 1,
		"lastCheck": "2026-05-07T08:16:00.000000"
	}
]