Connectors

List the connectors

get/api/v1/account/organizations/{id}/connectors

Request

  • Base URL
    https://pcp.example.com
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Organization ID, at or below the caller's.

Query parameters

type'source' | 'destination' | 'store' required

Connector kind.

offsetinteger

Number of items to skip.

limitinteger

Maximum number of items to return.

searchstring

Free-text search on connectors.

residencystring

Only connectors in this country.

inventory_idstring uuid

Only connectors of this inventory.

without_residencyboolean

Only connectors without a residency. Not combinable with residency.

exclude_lockedboolean

Exclude locked connectors.

Response

OK

totalinteger

Changes

No recorded changes to this operation across all 1 revision of this API.