HTTP Connector Endpoints

HTTP Connector Endpoints define the individual API operations (method + URI) available under an HTTP Connector Resource. Each endpoint specifies its HTTP method, relative URI template, query/path parameter definitions, and supported-by rules that control how exports and imports are pre-configured when users select this endpoint.

Endpoints are classified by supportedBy.type:

• export — reads data from the target system.
• import — writes data to the target system.

HTTP connector endpoint schema

List HTTP Connector Endpoints for a connector resource

get

/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/httpconnectorendpoints

Returns all endpoints defined under the given HTTP Connector Resource. The list response is abridged — only _id, name, createdAt, and lastModified are returned. Use the by-ID endpoint for the full object including method, relativeURI, and supportedBy.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_httpConnectorIdstring · objectIdRequired

HTTP Connector ID.

Example: 62a1f2c3b4d5e6f7a8b9c0d1

_httpConnectorResourceIdstring · objectIdRequired

HTTP Connector Resource ID.

Example: 63987132784a39b73aae63e7

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.

supportedByTypestring · enumOptional

Filter endpoints by their supported-by direction.

Possible values:

publishedOnlybooleanOptional

When true, only return published endpoints.

Responses

200

Successfully retrieved list of HTTP Connector Endpoints.

application/json

204

No endpoints exist for this resource (or none match the filter).

401

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[].

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

get/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/httpconnectorendpoints

GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/httpconnectorendpoints HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "63987132784a39b73aae63e8",
    "name": "List",
    "createdAt": "2023-01-17T09:52:06.871Z",
    "lastModified": "2024-05-23T07:00:46.308Z"
  },
  {
    "_id": "63987132784a39b73aae63e9",
    "name": "Read",
    "createdAt": "2023-01-17T09:52:07.219Z",
    "lastModified": "2024-05-23T07:00:46.660Z"
  }
]

Get an HTTP connector endpoint

get

/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}

Retrieves the full HTTP Connector Endpoint including method, relativeURI, queryParameters, pathParameters, and supportedBy details omitted from the list endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_httpConnectorIdstring · objectIdRequired

HTTP Connector ID.

Example: 62a1f2c3b4d5e6f7a8b9c0d1

_httpConnectorResourceIdstring · objectIdRequired

HTTP Connector Resource ID.

Example: 63987132784a39b73aae63e7

_idstring · objectIdRequired

HTTP Connector Endpoint ID.

Example: 63987132784a39b73aae63e8

Responses

200

HTTP Connector Endpoint retrieved successfully.

application/json

HTTP Connector Endpoint object as returned by the detail (by-ID) endpoint.

namestring · max: 255Required

Human-readable name for this endpoint

Example: List

descriptionstring · max: 10240Optional

Optional endpoint description

Example: Returns all answers for a question.

publishedbooleanRequired

When true, this endpoint is published and available for use.

isBlobbooleanOptional

When true, this endpoint handles binary/blob data.

Default: false

isMappingRequiredbooleanOptional

When true, field mapping is required for this endpoint.

Default: false

_httpConnectorResourceIdsstring · objectId[]Optional

References to HTTP Connector Resources associated with this endpoint

methodstring · enumRequired

HTTP method for this endpoint. Required on save; lowercase input is uppercased automatically.

Possible values:

relativeURIstringRequired

Relative URI template for this endpoint

Example: /api/public/answer/?page={{{export.http.paging.page}}}

mergePostBodyToPagingPostBodybooleanOptional

When true, merges the postBody into pagingPostBody for paginated requests.

Default: false

_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Format is a 24-character hexadecimal string.

Example: 5f8d43a1b9e5a80011a35f2c

createdAtstring · date-timeRead-onlyRequired

Timestamp when the resource was created. Set automatically and cannot be modified.

Example: 2023-04-01T09:15:32Z

lastModifiedstring · date-timeRead-onlyRequired

Timestamp when the resource was last updated. Changes whenever any property is modified.

Example: 2023-04-15T14:30:15Z

deletedAtstring · nullableRead-onlyOptional

Timestamp when the resource was soft-deleted. When null or absent, the resource is active.

Example: 2023-05-20T11:45:32Z

_userIdstring · objectIdRead-onlyOptional

Owner user id

Example: 55f9d6e0c1a2b3d4e5f60718

401

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[].

application/json

403

Forbidden. The authenticated caller does not have permission to perform this operation.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

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

GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63987132784a39b73aae63e8",
  "name": "List",
  "createdAt": "2023-01-17T09:52:06.871Z",
  "lastModified": "2024-05-23T07:00:46.308Z",
  "published": true,
  "isBlob": false,
  "isMappingRequired": false,
  "mergePostBodyToPagingPostBody": false,
  "_httpConnectorResourceIds": [
    "63987132784a39b73aae63e7"
  ],
  "method": "GET",
  "relativeURI": "/api/public/answer/?page={{{export.http.paging.page}}}",
  "queryParameters": [
    {
      "name": "question_id",
      "label": "Question ID",
      "description": "Include only answers for a question with the specified ID.",
      "required": false,
      "dataType": "input"
    }
  ],
  "supportedBy": {
    "type": "export",
    "preConfiguredFields": [
      {
        "path": "response",
        "values": [
          {
            "resourcePath": "results"
          }
        ]
      }
    ],
    "fieldsUserMustSet": [
      {
        "path": "type",
        "values": [
          "delta",
          "test"
        ]
      }
    ]
  }
}