For the complete documentation index, see llms.txt. This page is also available as Markdown.

HTTP Connector Resources

HTTP Connector Resources are the logical API groupings (for example "Account", "Contact", "Order") inside an HTTP Connector. Each resource belongs to one connector, is available in one or more of its versions, and owns the HTTP Connector Endpoints that define the operations users can build exports and imports on.

Manage your own resources through /v1/httpconnectorresources (list, create) and /v1/httpconnectorresources/{_id} (get, update, delete). The nested /v1/httpconnectors/{_httpConnectorId}/... routes are read-only views scoped to one connector that also reach resources published by other partners; a resource read through either route is the same object.

HTTP connector resource schema

List your HTTP Connector Resources

get
/v1/httpconnectorresources

Returns the full HTTP Connector Resources owned by the account, across all of its connectors, sorted by name. This is the canonical CRUD listing; to browse the resources of one connector — including resources published by other partners — use the scoped GET /v1/httpconnectors/{_httpConnectorId}/httpconnectorresources, which returns an abridged shape.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
limitinteger · min: 1Optional

Maximum number of records to return per page.

Example: 100
afterstringOptional

Opaque cursor for forward pagination. Pass the value from the Link response header (rel="next") to fetch the next page.

Responses
200

Array of the account's HTTP Connector Resources.

application/json
get/v1/httpconnectorresources
GET /v1/httpconnectorresources HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "_id": "6ab1f8b66c46f82ea7b1f20e",
    "name": "Account",
    "createdAt": "2026-09-22T03:40:38.704Z",
    "lastModified": "2026-09-22T03:41:34.542Z",
    "published": true,
    "_httpConnectorId": "6ab1f8b6d38090b49147cec4",
    "_versionIds": [
      "6ab1f8b6d38090b49147cec5"
    ]
  },
  {
    "_id": "6ab1f8c4c2e18361293b46b7",
    "name": "Contact",
    "createdAt": "2026-09-22T03:40:52.719Z",
    "lastModified": "2026-09-22T03:40:52.740Z",
    "published": false,
    "_httpConnectorId": "6ab1f8b6d38090b49147cec4"
  }
]

Create an HTTP Connector Resource

post
/v1/httpconnectorresources

Creates a resource grouping under one of your HTTP Connectors. Create the connector first (POST /v1/httpconnectors) and pass its id as _httpConnectorId; list the connector's versions[]._id values in _versionIds to make the resource available in those versions. Endpoints are then attached to the resource through POST /v1/httpconnectorendpoints.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Fields for creating or updating an HTTP Connector Resource through POST /v1/httpconnectorresources and PUT /v1/httpconnectorresources/{_id}. PUT replaces the whole document — omitted optional fields are cleared, except published and isRoot, which keep their stored values.

namestringRequired

Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").

Example: Account
publishedbooleanOptional

When true, the resource is visible to users of the connector's published catalog. Only resources whose owner may publish HTTP connectors appear to other accounts.

Default: false
_httpConnectorIdstring · objectIdRequired

HTTP Connector this resource belongs to. Must be a connector owned by the caller's account.

Example: 63987132784a39b73aae63cd
_httpConnectorApiIdstring · objectIdOptional

API group (an entry of the connector's apis[]) this resource belongs to. Set only for grouped connectors; flat connectors scope resources by _versionIds instead.

Example: 63987132784a39b73aae63d0
_versionIdsstring · objectId[]Optional

Connector (or API group) versions this resource is available in. Each id must be one of the connector's versions[]._id values.

Example: ["63987132784a39b73aae63ce"]
_parentResourceIdstring · objectIdOptional

Parent resource when this resource is nested under another one (for example "Order line" under "Order"). Omit for top-level resources; cannot be combined with isRoot: true.

Example: 63987132784a39b73aae63e7
isRootbooleanOptional

When true, marks the resource as the root of a resource hierarchy. Rejected together with _parentResourceId.

Default: false
Responses
201

Created resource.

application/json

HTTP Connector Resource as returned by GET /v1/httpconnectorresources, GET /v1/httpconnectorresources/{_id}, and the nested GET /v1/httpconnectors/{_httpConnectorId}/{_id} — all three return the same object. Optional fields that were never set are absent.

namestringRequired

Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").

Example: Account
publishedbooleanRequired

When true, the resource is visible to users of the connector's published catalog. Only resources whose owner may publish HTTP connectors appear to other accounts.

Default: false
_httpConnectorIdstring · objectIdRequired

HTTP Connector this resource belongs to. Must be a connector owned by the caller's account.

Example: 63987132784a39b73aae63cd
_httpConnectorApiIdstring · objectIdOptional

API group (an entry of the connector's apis[]) this resource belongs to. Set only for grouped connectors; flat connectors scope resources by _versionIds instead.

Example: 63987132784a39b73aae63d0
_versionIdsstring · objectId[]Optional

Connector (or API group) versions this resource is available in. Each id must be one of the connector's versions[]._id values.

Example: ["63987132784a39b73aae63ce"]
_parentResourceIdstring · objectIdOptional

Parent resource when this resource is nested under another one (for example "Order line" under "Order"). Omit for top-level resources; cannot be combined with isRoot: true.

Example: 63987132784a39b73aae63e7
isRootbooleanOptional

When true, marks the resource as the root of a resource hierarchy. Rejected together with _parentResourceId.

Default: false
_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Doubles as the _httpConnectorResourceId path parameter of the HTTP Connector Endpoints API.

Example: 63987132784a39b73aae63e7
createdAtstring · date-timeRead-onlyRequired

Timestamp when the resource was created.

Example: 2023-01-17T09:51:53.665Z
lastModifiedstring · date-timeRead-onlyRequired

Timestamp when the resource was last updated. Changes on every PUT.

Example: 2024-05-23T07:00:31.350Z
post/v1/httpconnectorresources
POST /v1/httpconnectorresources HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "name": "Account",
  "_httpConnectorId": "6ab1f8b6d38090b49147cec4",
  "_versionIds": [
    "6ab1f8b6d38090b49147cec5"
  ]
}
{
  "_id": "6ab1f8b66c46f82ea7b1f20e",
  "name": "Account",
  "createdAt": "2026-09-22T03:40:38.704Z",
  "lastModified": "2026-09-22T03:40:38.736Z",
  "published": false,
  "_httpConnectorId": "6ab1f8b6d38090b49147cec4",
  "_versionIds": [
    "6ab1f8b6d38090b49147cec5"
  ]
}

Get one of your HTTP Connector Resources

get
/v1/httpconnectorresources/{_id}

Returns the full resource. The nested GET /v1/httpconnectors/{_httpConnectorId}/{_id} returns the identical object and additionally reaches resources published by other partners; this route is limited to resources the account owns.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
_idstring · objectIdRequired

HTTP Connector Resource ID.

Example: 6ab1f8b66c46f82ea7b1f20e
Responses
200

The resource.

application/json

HTTP Connector Resource as returned by GET /v1/httpconnectorresources, GET /v1/httpconnectorresources/{_id}, and the nested GET /v1/httpconnectors/{_httpConnectorId}/{_id} — all three return the same object. Optional fields that were never set are absent.

namestringRequired

Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").

Example: Account
publishedbooleanRequired

When true, the resource is visible to users of the connector's published catalog. Only resources whose owner may publish HTTP connectors appear to other accounts.

Default: false
_httpConnectorIdstring · objectIdRequired

HTTP Connector this resource belongs to. Must be a connector owned by the caller's account.

Example: 63987132784a39b73aae63cd
_httpConnectorApiIdstring · objectIdOptional

API group (an entry of the connector's apis[]) this resource belongs to. Set only for grouped connectors; flat connectors scope resources by _versionIds instead.

Example: 63987132784a39b73aae63d0
_versionIdsstring · objectId[]Optional

Connector (or API group) versions this resource is available in. Each id must be one of the connector's versions[]._id values.

Example: ["63987132784a39b73aae63ce"]
_parentResourceIdstring · objectIdOptional

Parent resource when this resource is nested under another one (for example "Order line" under "Order"). Omit for top-level resources; cannot be combined with isRoot: true.

Example: 63987132784a39b73aae63e7
isRootbooleanOptional

When true, marks the resource as the root of a resource hierarchy. Rejected together with _parentResourceId.

Default: false
_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Doubles as the _httpConnectorResourceId path parameter of the HTTP Connector Endpoints API.

Example: 63987132784a39b73aae63e7
createdAtstring · date-timeRead-onlyRequired

Timestamp when the resource was created.

Example: 2023-01-17T09:51:53.665Z
lastModifiedstring · date-timeRead-onlyRequired

Timestamp when the resource was last updated. Changes on every PUT.

Example: 2024-05-23T07:00:31.350Z
get/v1/httpconnectorresources/{_id}
GET /v1/httpconnectorresources/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "_id": "6ab1f8b66c46f82ea7b1f20e",
  "name": "Account",
  "createdAt": "2026-09-22T03:40:38.704Z",
  "lastModified": "2026-09-22T03:41:34.542Z",
  "published": true,
  "_httpConnectorId": "6ab1f8b6d38090b49147cec4",
  "_versionIds": [
    "6ab1f8b6d38090b49147cec5"
  ]
}

Update an HTTP Connector Resource

put
/v1/httpconnectorresources/{_id}

Replaces the resource with the request body. Send the complete document — _versionIds, metadata, resourceFields, supportedBy, and the other optional fields are cleared when left out, while published and isRoot keep their stored values when omitted. name and _httpConnectorId are required on every PUT. Publish a resource by sending published: true.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
_idstring · objectIdRequired

HTTP Connector Resource ID.

Example: 6ab1f8b66c46f82ea7b1f20e
Body

Fields for creating or updating an HTTP Connector Resource through POST /v1/httpconnectorresources and PUT /v1/httpconnectorresources/{_id}. PUT replaces the whole document — omitted optional fields are cleared, except published and isRoot, which keep their stored values.

namestringRequired

Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").

Example: Account
publishedbooleanOptional

When true, the resource is visible to users of the connector's published catalog. Only resources whose owner may publish HTTP connectors appear to other accounts.

Default: false
_httpConnectorIdstring · objectIdRequired

HTTP Connector this resource belongs to. Must be a connector owned by the caller's account.

Example: 63987132784a39b73aae63cd
_httpConnectorApiIdstring · objectIdOptional

API group (an entry of the connector's apis[]) this resource belongs to. Set only for grouped connectors; flat connectors scope resources by _versionIds instead.

Example: 63987132784a39b73aae63d0
_versionIdsstring · objectId[]Optional

Connector (or API group) versions this resource is available in. Each id must be one of the connector's versions[]._id values.

Example: ["63987132784a39b73aae63ce"]
_parentResourceIdstring · objectIdOptional

Parent resource when this resource is nested under another one (for example "Order line" under "Order"). Omit for top-level resources; cannot be combined with isRoot: true.

Example: 63987132784a39b73aae63e7
isRootbooleanOptional

When true, marks the resource as the root of a resource hierarchy. Rejected together with _parentResourceId.

Default: false
Responses
200

Updated resource.

application/json

HTTP Connector Resource as returned by GET /v1/httpconnectorresources, GET /v1/httpconnectorresources/{_id}, and the nested GET /v1/httpconnectors/{_httpConnectorId}/{_id} — all three return the same object. Optional fields that were never set are absent.

namestringRequired

Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").

Example: Account
publishedbooleanRequired

When true, the resource is visible to users of the connector's published catalog. Only resources whose owner may publish HTTP connectors appear to other accounts.

Default: false
_httpConnectorIdstring · objectIdRequired

HTTP Connector this resource belongs to. Must be a connector owned by the caller's account.

Example: 63987132784a39b73aae63cd
_httpConnectorApiIdstring · objectIdOptional

API group (an entry of the connector's apis[]) this resource belongs to. Set only for grouped connectors; flat connectors scope resources by _versionIds instead.

Example: 63987132784a39b73aae63d0
_versionIdsstring · objectId[]Optional

Connector (or API group) versions this resource is available in. Each id must be one of the connector's versions[]._id values.

Example: ["63987132784a39b73aae63ce"]
_parentResourceIdstring · objectIdOptional

Parent resource when this resource is nested under another one (for example "Order line" under "Order"). Omit for top-level resources; cannot be combined with isRoot: true.

Example: 63987132784a39b73aae63e7
isRootbooleanOptional

When true, marks the resource as the root of a resource hierarchy. Rejected together with _parentResourceId.

Default: false
_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Doubles as the _httpConnectorResourceId path parameter of the HTTP Connector Endpoints API.

Example: 63987132784a39b73aae63e7
createdAtstring · date-timeRead-onlyRequired

Timestamp when the resource was created.

Example: 2023-01-17T09:51:53.665Z
lastModifiedstring · date-timeRead-onlyRequired

Timestamp when the resource was last updated. Changes on every PUT.

Example: 2024-05-23T07:00:31.350Z
put/v1/httpconnectorresources/{_id}
PUT /v1/httpconnectorresources/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "name": "Account",
  "_httpConnectorId": "6ab1f8b6d38090b49147cec4",
  "_versionIds": [
    "6ab1f8b6d38090b49147cec5"
  ],
  "published": true
}
{
  "_id": "6ab1f8b66c46f82ea7b1f20e",
  "name": "Account",
  "createdAt": "2026-09-22T03:40:38.704Z",
  "lastModified": "2026-09-22T03:41:34.542Z",
  "published": true,
  "_httpConnectorId": "6ab1f8b6d38090b49147cec4",
  "_versionIds": [
    "6ab1f8b6d38090b49147cec5"
  ]
}

Delete an HTTP Connector Resource

delete
/v1/httpconnectorresources/{_id}

Deletes the resource. Refused while any HTTP Connector Endpoint still lists it in _httpConnectorResourceIds — delete or re-point those endpoints first. A connector likewise cannot be deleted while it still has resources. Not recoverable through the recycle bin.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
_idstring · objectIdRequired

HTTP Connector Resource ID.

Example: 6ab1f8b66c46f82ea7b1f20e
Responses
204

Resource deleted.

No content

delete/v1/httpconnectorresources/{_id}
DELETE /v1/httpconnectorresources/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List a connector's HTTP Connector Resources

get
/v1/httpconnectors/{_httpConnectorId}/httpconnectorresources

Returns the resources defined under the given HTTP Connector — your own and, for connectors published by other partners, their published resources — sorted by name. The whole list is returned in one response.

The shape is abridged: it omits published, _httpConnectorId, and the configuration fields. Use GET /v1/httpconnectors/{_httpConnectorId}/{_id} for the full object, or GET /v1/httpconnectorresources for the full shape of everything your account owns.

Each resource's _id doubles as the _httpConnectorResourceId path parameter used by the HTTP Connector Endpoints API.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
_httpConnectorIdstring · objectIdRequired

HTTP Connector ID.

Example: 63987132784a39b73aae63cd
Query parameters
versionstring · objectIdOptional

Return only resources available in this connector version (versions[]._id).

Example: 63987132784a39b73aae63ce
publishedOnlybooleanOptional

When true, returns only published resources that belong to a published version of the connector. The connector itself must be published, otherwise the request fails with 404.

Default: false
Responses
200

Abridged resources of the connector.

application/json

Abridged HTTP Connector Resource returned by the nested GET /v1/httpconnectors/{_httpConnectorId}/httpconnectorresources catalog listing. Omits published, _httpConnectorId, and the configuration fields; fetch the full object by id.

_idstring · objectIdRead-onlyRequired

Unique identifier for the resource.

Example: 63987132784a39b73aae63e7
namestringRequired

Human-readable name of the API resource.

Example: Account
_versionIdsstring · objectId[]Optional

Connector version IDs this resource is available in. Absent when the resource is not tied to a version.

Example: ["63987132784a39b73aae63ce"]
createdAtstring · date-timeRead-onlyRequired

Timestamp when the resource was created.

Example: 2023-01-17T09:51:53.665Z
lastModifiedstring · date-timeRead-onlyRequired

Timestamp when the resource was last updated.

Example: 2024-05-23T07:00:29.858Z
get/v1/httpconnectors/{_httpConnectorId}/httpconnectorresources
GET /v1/httpconnectors/{_httpConnectorId}/httpconnectorresources HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "_id": "63987132784a39b73aae63e7",
    "name": "Answer",
    "createdAt": "2023-01-17T09:51:53.665Z",
    "lastModified": "2024-05-23T07:00:31.350Z",
    "_versionIds": [
      "63987132784a39b73aae63ce"
    ]
  },
  {
    "_id": "63987132784a39b73aae63e1",
    "name": "Attribute",
    "createdAt": "2023-01-17T09:51:52.118Z",
    "lastModified": "2024-05-23T07:00:29.858Z",
    "_versionIds": [
      "63987132784a39b73aae63ce"
    ]
  }
]

Get an HTTP connector resource

get
/v1/httpconnectors/{_httpConnectorId}/{_id}

Retrieves a specific HTTP Connector Resource by its unique identifier — the same object GET /v1/httpconnectorresources/{_id} returns, but this route also reaches resources published by other partners.

The path uses a shortcut form: /v1/httpconnectors/{_httpConnectorId}/{_id} where {_id} is the resource ID directly under the connector. The longer form /v1/httpconnectors/{_httpConnectorId}/httpconnectorresources/{_id} is not supported and fails with an invalid_ref error.

The detail response includes published, _httpConnectorId, and the configuration fields that are omitted from the list endpoint.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
_httpConnectorIdstring · objectIdRequired

HTTP Connector ID

Example: 63987132784a39b73aae63cd
_idstring · objectIdRequired

HTTP Connector Resource ID

Example: 63987132784a39b73aae63e7
Responses
200

HTTP Connector Resource retrieved successfully

application/json

HTTP Connector Resource as returned by GET /v1/httpconnectorresources, GET /v1/httpconnectorresources/{_id}, and the nested GET /v1/httpconnectors/{_httpConnectorId}/{_id} — all three return the same object. Optional fields that were never set are absent.

namestringRequired

Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").

Example: Account
publishedbooleanRequired

When true, the resource is visible to users of the connector's published catalog. Only resources whose owner may publish HTTP connectors appear to other accounts.

Default: false
_httpConnectorIdstring · objectIdRequired

HTTP Connector this resource belongs to. Must be a connector owned by the caller's account.

Example: 63987132784a39b73aae63cd
_httpConnectorApiIdstring · objectIdOptional

API group (an entry of the connector's apis[]) this resource belongs to. Set only for grouped connectors; flat connectors scope resources by _versionIds instead.

Example: 63987132784a39b73aae63d0
_versionIdsstring · objectId[]Optional

Connector (or API group) versions this resource is available in. Each id must be one of the connector's versions[]._id values.

Example: ["63987132784a39b73aae63ce"]
_parentResourceIdstring · objectIdOptional

Parent resource when this resource is nested under another one (for example "Order line" under "Order"). Omit for top-level resources; cannot be combined with isRoot: true.

Example: 63987132784a39b73aae63e7
isRootbooleanOptional

When true, marks the resource as the root of a resource hierarchy. Rejected together with _parentResourceId.

Default: false
_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Doubles as the _httpConnectorResourceId path parameter of the HTTP Connector Endpoints API.

Example: 63987132784a39b73aae63e7
createdAtstring · date-timeRead-onlyRequired

Timestamp when the resource was created.

Example: 2023-01-17T09:51:53.665Z
lastModifiedstring · date-timeRead-onlyRequired

Timestamp when the resource was last updated. Changes on every PUT.

Example: 2024-05-23T07:00:31.350Z
get/v1/httpconnectors/{_httpConnectorId}/{_id}
GET /v1/httpconnectors/{_httpConnectorId}/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "_id": "63987132784a39b73aae63e7",
  "name": "Answer",
  "createdAt": "2023-01-17T09:51:53.665Z",
  "lastModified": "2024-05-23T07:00:31.350Z",
  "published": true,
  "_httpConnectorId": "63987132784a39b73aae63cd",
  "_versionIds": [
    "63987132784a39b73aae63ce"
  ]
}

Last updated

Was this helpful?