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.

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

HTTP connector endpoint schema

List your HTTP Connector Endpoints

get

/v1/httpconnectorendpoints

Returns the full HTTP Connector Endpoints owned by the account, across all of its connectors and resources, sorted by name. This is the canonical CRUD listing; to browse the endpoints of one resource — including endpoints published by other partners — use the scoped GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/httpconnectorendpoints, 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 Endpoints.

application/json

204

The account owns no HTTP Connector Endpoints.

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

get/v1/httpconnectorendpoints

GET /v1/httpconnectorendpoints HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "6ab1f999d38090b49147cf00",
    "name": "List items",
    "description": "Returns the items of the account.",
    "createdAt": "2026-09-22T03:44:25.604Z",
    "lastModified": "2026-09-22T03:44:25.662Z",
    "published": false,
    "isBlob": false,
    "isMappingRequired": true,
    "mergePostBodyToPagingPostBody": false,
    "_httpConnectorResourceIds": [
      "6ab1f97fdda4c325517b57b9"
    ],
    "method": "GET",
    "relativeURI": "/items/{{{id}}}",
    "queryParameters": [
      {
        "name": "status",
        "label": "Status",
        "description": "Filter by status",
        "required": false,
        "dataType": "select",
        "values": [
          "open",
          "closed"
        ]
      }
    ],
    "pathParameters": [
      {
        "name": "id",
        "label": "Item ID",
        "required": true,
        "dataType": "input"
      }
    ],
    "supportedBy": {
      "type": "export",
      "preConfiguredFields": [
        {
          "path": "http.response.resourcePath",
          "values": [
            "data"
          ]
        }
      ],
      "fieldsUserMustSet": [
        {
          "path": "type",
          "values": [
            "delta",
            "test"
          ]
        }
      ],
      "fieldsToUnset": [
        "http.paging.method"
      ]
    }
  }
]

Create an HTTP Connector Endpoint

post

/v1/httpconnectorendpoints

Creates an operation under one or more of your HTTP Connector Resources. Create the resource first (POST /v1/httpconnectorresources) and list its id in _httpConnectorResourceIds; supportedBy.type decides whether users build exports or imports on the endpoint. method is uppercased on save, so get is stored as GET.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Fields for creating or updating an HTTP Connector Endpoint through POST /v1/httpconnectorendpoints and PUT /v1/httpconnectorendpoints/{_id}. PUT replaces the whole document — omitted optional fields are cleared (isMappingRequired and mergePostBodyToPagingPostBody revert to false), except published and isBlob, which keep their stored values.

namestring · max: 255Required

Human-readable name for this endpoint, shown when users pick an operation.

Example: List

descriptionstring · max: 10240Optional

Help text describing what the endpoint does. Absent when never set.

Example: Returns all answers for a question.

publishedbooleanOptional

When true, this endpoint is visible in the connector's published catalog. Kept as stored when omitted on PUT.

Default: false

isBlobbooleanOptional

When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT.

Default: false

isMappingRequiredbooleanOptional

When true, users must configure field mappings before an import built on this endpoint can run.

Default: false

_httpConnectorResourceIdsstring · objectId[] · min: 1Required

HTTP Connector Resources this endpoint is listed under. Each id must be a resource owned by the caller's account; the endpoint appears in the nested listing of every resource named here.

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

Responses

201

Created endpoint.

application/json

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

namestring · max: 255Required

Human-readable name for this endpoint, shown when users pick an operation.

Example: List

descriptionstring · max: 10240Optional

Help text describing what the endpoint does. Absent when never set.

Example: Returns all answers for a question.

publishedbooleanRequired

When true, this endpoint is visible in the connector's published catalog. Kept as stored when omitted on PUT.

Default: false

isBlobbooleanRequired

When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT.

Default: false

isMappingRequiredbooleanRequired

When true, users must configure field mappings before an import built on this endpoint can run.

Default: false

_httpConnectorResourceIdsstring · objectId[] · min: 1Required

HTTP Connector Resources this endpoint is listed under. Each id must be a resource owned by the caller's account; the endpoint appears in the nested listing of every resource named here.

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}}}

mergePostBodyToPagingPostBodybooleanRequired

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

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

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

422

A required field is missing, method or supportedBy.type is outside its enum, a referenced resource or lookup endpoint is not yours, or Data Intelligence metadata was sent for an unpublished endpoint. Several problems are reported together.

application/json

post/v1/httpconnectorendpoints

POST /v1/httpconnectorendpoints HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "name": "List items",
  "method": "GET",
  "relativeURI": "/items",
  "_httpConnectorResourceIds": [
    "6ab1f97fdda4c325517b57b9"
  ],
  "supportedBy": {
    "type": "export"
  }
}

{
  "_id": "6ab1f999d38090b49147cf00",
  "name": "List items",
  "createdAt": "2026-09-22T03:44:25.604Z",
  "lastModified": "2026-09-22T03:44:25.662Z",
  "published": false,
  "isBlob": false,
  "isMappingRequired": false,
  "mergePostBodyToPagingPostBody": false,
  "_httpConnectorResourceIds": [
    "6ab1f97fdda4c325517b57b9"
  ],
  "method": "GET",
  "relativeURI": "/items",
  "supportedBy": {
    "type": "export"
  }
}

Get one of your HTTP Connector Endpoints

get

/v1/httpconnectorendpoints/{_id}

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstring · objectIdRequired

HTTP Connector Endpoint ID.

Example: 6ab1f999d38090b49147cf00

Responses

200

The endpoint.

application/json

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

namestring · max: 255Required

Human-readable name for this endpoint, shown when users pick an operation.

Example: List

descriptionstring · max: 10240Optional

Help text describing what the endpoint does. Absent when never set.

Example: Returns all answers for a question.

publishedbooleanRequired

When true, this endpoint is visible in the connector's published catalog. Kept as stored when omitted on PUT.

Default: false

isBlobbooleanRequired

When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT.

Default: false

isMappingRequiredbooleanRequired

When true, users must configure field mappings before an import built on this endpoint can run.

Default: false

_httpConnectorResourceIdsstring · objectId[] · min: 1Required

HTTP Connector Resources this endpoint is listed under. Each id must be a resource owned by the caller's account; the endpoint appears in the nested listing of every resource named here.

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}}}

mergePostBodyToPagingPostBodybooleanRequired

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

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

No endpoint with this id is owned by the account.

application/json

get/v1/httpconnectorendpoints/{_id}

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

{
  "_id": "6ab1f999d38090b49147cf00",
  "name": "List items",
  "description": "Returns the items of the account.",
  "createdAt": "2026-09-22T03:44:25.604Z",
  "lastModified": "2026-09-22T03:44:25.662Z",
  "published": false,
  "isBlob": false,
  "isMappingRequired": true,
  "mergePostBodyToPagingPostBody": false,
  "_httpConnectorResourceIds": [
    "6ab1f97fdda4c325517b57b9"
  ],
  "method": "GET",
  "relativeURI": "/items/{{{id}}}",
  "pathParameters": [
    {
      "name": "id",
      "label": "Item ID",
      "required": true,
      "dataType": "input"
    }
  ],
  "supportedBy": {
    "type": "export",
    "preConfiguredFields": [
      {
        "path": "http.response.resourcePath",
        "values": [
          "data"
        ]
      }
    ]
  }
}

Update an HTTP Connector Endpoint

put

/v1/httpconnectorendpoints/{_id}

Replaces the endpoint with the request body. Send the complete document — description, queryParameters, pathParameters, resourceFields, and the supportedBy details are cleared when left out and isMappingRequired / mergePostBodyToPagingPostBody revert to false, while published and isBlob keep their stored values when omitted. The five create-time requireds are required on every PUT.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstring · objectIdRequired

HTTP Connector Endpoint ID.

Example: 6ab1f999d38090b49147cf00

Body

Fields for creating or updating an HTTP Connector Endpoint through POST /v1/httpconnectorendpoints and PUT /v1/httpconnectorendpoints/{_id}. PUT replaces the whole document — omitted optional fields are cleared (isMappingRequired and mergePostBodyToPagingPostBody revert to false), except published and isBlob, which keep their stored values.

namestring · max: 255Required

Human-readable name for this endpoint, shown when users pick an operation.

Example: List

descriptionstring · max: 10240Optional

Help text describing what the endpoint does. Absent when never set.

Example: Returns all answers for a question.

publishedbooleanOptional

When true, this endpoint is visible in the connector's published catalog. Kept as stored when omitted on PUT.

Default: false

isBlobbooleanOptional

When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT.

Default: false

isMappingRequiredbooleanOptional

When true, users must configure field mappings before an import built on this endpoint can run.

Default: false

_httpConnectorResourceIdsstring · objectId[] · min: 1Required

HTTP Connector Resources this endpoint is listed under. Each id must be a resource owned by the caller's account; the endpoint appears in the nested listing of every resource named here.

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

Responses

200

Updated endpoint.

application/json

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

namestring · max: 255Required

Human-readable name for this endpoint, shown when users pick an operation.

Example: List

descriptionstring · max: 10240Optional

Help text describing what the endpoint does. Absent when never set.

Example: Returns all answers for a question.

publishedbooleanRequired

When true, this endpoint is visible in the connector's published catalog. Kept as stored when omitted on PUT.

Default: false

isBlobbooleanRequired

When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT.

Default: false

isMappingRequiredbooleanRequired

When true, users must configure field mappings before an import built on this endpoint can run.

Default: false

_httpConnectorResourceIdsstring · objectId[] · min: 1Required

HTTP Connector Resources this endpoint is listed under. Each id must be a resource owned by the caller's account; the endpoint appears in the nested listing of every resource named here.

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}}}

mergePostBodyToPagingPostBodybooleanRequired

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

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

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

422

Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.

application/json

put/v1/httpconnectorendpoints/{_id}

PUT /v1/httpconnectorendpoints/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "name": "Create item",
  "method": "POST",
  "relativeURI": "/items",
  "_httpConnectorResourceIds": [
    "6ab1f97fdda4c325517b57b9"
  ],
  "supportedBy": {
    "type": "import"
  }
}

{
  "_id": "6ab1f999d38090b49147cf00",
  "name": "Create item",
  "createdAt": "2026-09-22T03:44:25.604Z",
  "lastModified": "2026-09-22T03:41:33.711Z",
  "published": false,
  "isBlob": false,
  "isMappingRequired": false,
  "mergePostBodyToPagingPostBody": false,
  "_httpConnectorResourceIds": [
    "6ab1f97fdda4c325517b57b9"
  ],
  "method": "POST",
  "relativeURI": "/items",
  "supportedBy": {
    "type": "import"
  }
}

Delete an HTTP Connector Endpoint

delete

/v1/httpconnectorendpoints/{_id}

Deletes the endpoint. Refused while another endpoint still names it in supportedBy.lookupToIdentifyExisting._httpConnectorEndpointId — update or delete that endpoint first. Not recoverable through the recycle bin.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstring · objectIdRequired

HTTP Connector Endpoint ID.

Example: 6ab1f999d38090b49147cf00

Responses

204

Endpoint deleted.

No content

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

422

Another endpoint's lookup still references this endpoint.

application/json

delete/v1/httpconnectorendpoints/{_id}

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

No content

List a resource's HTTP Connector Endpoints

get

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

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

The shape is abridged: only _id, name, description, createdAt, and lastModified are returned. Use the by-ID endpoint for the full object including method, relativeURI, and supportedBy, or GET /v1/httpconnectorendpoints for the full shape of everything your account owns.

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

supportedByTypestring · enumOptional

Return only endpoints whose supportedBy.type matches.

Possible values:

publishedOnlybooleanOptional

When true, returns only published endpoints. The connector must be published as well, otherwise the request fails with 404.

Default: false

Responses

200

Abridged endpoints of the resource.

application/json

Abridged HTTP Connector Endpoint returned by the nested GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/httpconnectorendpoints catalog listing. Includes identity, description, and timestamps only; fetch the full object by id for method, relativeURI, and supportedBy.

_idstring · objectIdRead-onlyRequired

Unique identifier for the endpoint.

Example: 63987132784a39b73aae63e8

namestringRequired

Human-readable name for this endpoint.

Example: List

descriptionstringOptional

Help text describing what the endpoint does. Absent when never set.

Example: Returns all answers for a question.

createdAtstring · date-timeRead-onlyRequired

Timestamp when the endpoint was created.

Example: 2023-01-17T09:52:06.871Z

lastModifiedstring · date-timeRead-onlyRequired

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

Example: 2024-05-23T07:00:46.308Z

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

The connector or resource does not exist, or is neither yours nor published.

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",
    "description": "Returns all answers for a question.",
    "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 — the same object GET /v1/httpconnectorendpoints/{_id} returns, but this route also reaches endpoints published by other partners.

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 as returned by GET /v1/httpconnectorendpoints, GET /v1/httpconnectorendpoints/{_id}, and the nested GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id} — all three return the same object. Optional fields that were never set are absent.

namestring · max: 255Required

Human-readable name for this endpoint, shown when users pick an operation.

Example: List

descriptionstring · max: 10240Optional

Help text describing what the endpoint does. Absent when never set.

Example: Returns all answers for a question.

publishedbooleanRequired

When true, this endpoint is visible in the connector's published catalog. Kept as stored when omitted on PUT.

Default: false

isBlobbooleanRequired

When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT.

Default: false

isMappingRequiredbooleanRequired

When true, users must configure field mappings before an import built on this endpoint can run.

Default: false

_httpConnectorResourceIdsstring · objectId[] · min: 1Required

HTTP Connector Resources this endpoint is listed under. Each id must be a resource owned by the caller's account; the endpoint appears in the nested listing of every resource named here.

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}}}

mergePostBodyToPagingPostBodybooleanRequired

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

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"
        ]
      }
    ]
  }
}