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
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.
Maximum number of records to return per page.
100Opaque cursor for forward pagination. Pass the value from the Link
response header (rel="next") to fetch the next page.
Array of the account's HTTP Connector Resources.
The account owns no HTTP Connector Resources.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Forbidden. The authenticated caller does not have permission to perform this operation.
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"
}
]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.
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.
Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").
AccountWhen 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.
falseHTTP Connector this resource belongs to. Must be a connector owned by the caller's account.
63987132784a39b73aae63cdAPI group (an entry of the connector's apis[]) this resource belongs
to. Set only for grouped connectors; flat connectors scope resources by
_versionIds instead.
63987132784a39b73aae63d0Connector (or API group) versions this resource is available in. Each
id must be one of the connector's versions[]._id values.
["63987132784a39b73aae63ce"]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.
63987132784a39b73aae63e7When true, marks the resource as the root of a resource hierarchy.
Rejected together with _parentResourceId.
falseCreated resource.
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.
Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").
AccountWhen 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.
falseHTTP Connector this resource belongs to. Must be a connector owned by the caller's account.
63987132784a39b73aae63cdAPI group (an entry of the connector's apis[]) this resource belongs
to. Set only for grouped connectors; flat connectors scope resources by
_versionIds instead.
63987132784a39b73aae63d0Connector (or API group) versions this resource is available in. Each
id must be one of the connector's versions[]._id values.
["63987132784a39b73aae63ce"]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.
63987132784a39b73aae63e7When true, marks the resource as the root of a resource hierarchy.
Rejected together with _parentResourceId.
falseUnique identifier for the resource. Doubles as the
_httpConnectorResourceId path parameter of the HTTP Connector
Endpoints API.
63987132784a39b73aae63e7Timestamp when the resource was created.
2023-01-17T09:51:53.665ZTimestamp when the resource was last updated. Changes on every PUT.
2024-05-23T07:00:31.350ZBad request. The server could not understand the request because of malformed syntax or invalid parameters.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Forbidden. The authenticated caller does not have permission to perform this operation.
A required field is missing, a referenced connector or version is not
yours or does not exist, or isRoot and _parentResourceId were sent
together.
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"
]
}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.
HTTP Connector Resource ID.
6ab1f8b66c46f82ea7b1f20eThe resource.
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.
Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").
AccountWhen 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.
falseHTTP Connector this resource belongs to. Must be a connector owned by the caller's account.
63987132784a39b73aae63cdAPI group (an entry of the connector's apis[]) this resource belongs
to. Set only for grouped connectors; flat connectors scope resources by
_versionIds instead.
63987132784a39b73aae63d0Connector (or API group) versions this resource is available in. Each
id must be one of the connector's versions[]._id values.
["63987132784a39b73aae63ce"]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.
63987132784a39b73aae63e7When true, marks the resource as the root of a resource hierarchy.
Rejected together with _parentResourceId.
falseUnique identifier for the resource. Doubles as the
_httpConnectorResourceId path parameter of the HTTP Connector
Endpoints API.
63987132784a39b73aae63e7Timestamp when the resource was created.
2023-01-17T09:51:53.665ZTimestamp when the resource was last updated. Changes on every PUT.
2024-05-23T07:00:31.350ZUnauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Forbidden. The authenticated caller does not have permission to perform this operation.
No resource with this id is owned by the account.
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"
]
}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.
HTTP Connector Resource ID.
6ab1f8b66c46f82ea7b1f20eFields 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.
Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").
AccountWhen 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.
falseHTTP Connector this resource belongs to. Must be a connector owned by the caller's account.
63987132784a39b73aae63cdAPI group (an entry of the connector's apis[]) this resource belongs
to. Set only for grouped connectors; flat connectors scope resources by
_versionIds instead.
63987132784a39b73aae63d0Connector (or API group) versions this resource is available in. Each
id must be one of the connector's versions[]._id values.
["63987132784a39b73aae63ce"]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.
63987132784a39b73aae63e7When true, marks the resource as the root of a resource hierarchy.
Rejected together with _parentResourceId.
falseUpdated resource.
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.
Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").
AccountWhen 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.
falseHTTP Connector this resource belongs to. Must be a connector owned by the caller's account.
63987132784a39b73aae63cdAPI group (an entry of the connector's apis[]) this resource belongs
to. Set only for grouped connectors; flat connectors scope resources by
_versionIds instead.
63987132784a39b73aae63d0Connector (or API group) versions this resource is available in. Each
id must be one of the connector's versions[]._id values.
["63987132784a39b73aae63ce"]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.
63987132784a39b73aae63e7When true, marks the resource as the root of a resource hierarchy.
Rejected together with _parentResourceId.
falseUnique identifier for the resource. Doubles as the
_httpConnectorResourceId path parameter of the HTTP Connector
Endpoints API.
63987132784a39b73aae63e7Timestamp when the resource was created.
2023-01-17T09:51:53.665ZTimestamp when the resource was last updated. Changes on every PUT.
2024-05-23T07:00:31.350ZBad request. The server could not understand the request because of malformed syntax or invalid parameters.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Forbidden. The authenticated caller does not have permission to perform this operation.
Not found. The requested resource does not exist or is not visible to the caller.
Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.
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"
]
}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.
HTTP Connector Resource ID.
6ab1f8b66c46f82ea7b1f20eResource deleted.
No content
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Forbidden. The authenticated caller does not have permission to perform this operation.
Not found. The requested resource does not exist or is not visible to the caller.
An endpoint still references the resource.
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
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.
HTTP Connector ID.
63987132784a39b73aae63cdReturn only resources available in this connector version (versions[]._id).
63987132784a39b73aae63ceWhen 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.
falseAbridged resources of the connector.
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.
Unique identifier for the resource.
63987132784a39b73aae63e7Human-readable name of the API resource.
AccountConnector version IDs this resource is available in. Absent when the resource is not tied to a version.
["63987132784a39b73aae63ce"]Timestamp when the resource was created.
2023-01-17T09:51:53.665ZTimestamp when the resource was last updated.
2024-05-23T07:00:29.858ZThe connector has no resources visible to the caller.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
The connector does not exist, is not yours, and is not published.
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"
]
}
]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.
HTTP Connector ID
63987132784a39b73aae63cdHTTP Connector Resource ID
63987132784a39b73aae63e7HTTP Connector Resource retrieved successfully
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.
Human-readable name of the API resource this grouping represents (for example "Account", "Contact", "Order").
AccountWhen 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.
falseHTTP Connector this resource belongs to. Must be a connector owned by the caller's account.
63987132784a39b73aae63cdAPI group (an entry of the connector's apis[]) this resource belongs
to. Set only for grouped connectors; flat connectors scope resources by
_versionIds instead.
63987132784a39b73aae63d0Connector (or API group) versions this resource is available in. Each
id must be one of the connector's versions[]._id values.
["63987132784a39b73aae63ce"]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.
63987132784a39b73aae63e7When true, marks the resource as the root of a resource hierarchy.
Rejected together with _parentResourceId.
falseUnique identifier for the resource. Doubles as the
_httpConnectorResourceId path parameter of the HTTP Connector
Endpoints API.
63987132784a39b73aae63e7Timestamp when the resource was created.
2023-01-17T09:51:53.665ZTimestamp when the resource was last updated. Changes on every PUT.
2024-05-23T07:00:31.350ZInvalid resource ID
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Resource not found or not published. Also returned when the
_httpConnectorId is valid but the resource ID doesn't belong to it.
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?