> For the complete documentation index, see [llms.txt](https://developer.celigo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints.md). # 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 ## The HTTPConnectorEndpoint object ```json {"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"components":{"schemas":{"HTTPConnectorEndpoint":{"type":"object","required":["_id","name","method","relativeURI","published","isBlob","isMappingRequired","mergePostBodyToPagingPostBody","_httpConnectorResourceIds","createdAt","lastModified"],"description":"HTTP Connector Endpoint as returned by `GET /v1/httpconnectorendpoints`,\n`GET /v1/httpconnectorendpoints/{_id}`, and the nested\n`GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}`\n— all three return the same object. Optional fields that were never set\nare absent.","allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"},{"$ref":"#/components/schemas/ResourceResponse"},{"type":"object","properties":{"metadata":{"type":"object","description":"Endpoint metadata used by Data Intelligence tooling. Absent when\nnever set; Data Intelligence attributes can only be stored on a\npublished endpoint.","properties":{"di":{"type":"object","description":"Data Intelligence attributes for this endpoint.","properties":{"isListEndpoint":{"type":"boolean","description":"When true, the endpoint returns a list of records rather than a single record."},"responseFields":{"type":"array","description":"Fields Data Intelligence expects in this endpoint's response records.","items":{"type":"object","properties":{"id":{"type":"string","description":"Field path within a response record."},"dataType":{"type":"string","description":"Data type of the field."}}}}}}}}}}]},"HTTPConnectorEndpointBase":{"type":"object","description":"Writable fields shared by the request and response schemas.","properties":{"name":{"type":"string","description":"Human-readable name for this endpoint, shown when users pick an operation.","maxLength":255},"description":{"type":"string","description":"Help text describing what the endpoint does. Absent when never set.","maxLength":10240},"published":{"type":"boolean","default":false,"description":"When true, this endpoint is visible in the connector's published\ncatalog. Kept as stored when omitted on PUT."},"isBlob":{"type":"boolean","default":false,"description":"When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT."},"isMappingRequired":{"type":"boolean","default":false,"description":"When true, users must configure field mappings before an import built on this endpoint can run."},"_httpConnectorResourceIds":{"type":"array","minItems":1,"description":"HTTP Connector Resources this endpoint is listed under. Each id must\nbe a resource owned by the caller's account; the endpoint appears in\nthe nested listing of every resource named here.","items":{"type":"string","format":"objectId"}},"method":{"type":"string","enum":["GET","PUT","POST","PATCH","DELETE","HEAD"],"description":"HTTP method for this endpoint. Required on save; lowercase input is\nuppercased automatically."},"relativeURI":{"type":"string","description":"Relative URI template for this endpoint"},"mergePostBodyToPagingPostBody":{"type":"boolean","description":"When true, merges the postBody into pagingPostBody for paginated requests.","default":false},"queryParameters":{"type":"array","description":"Query parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the request query string."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"pathParameters":{"type":"array","description":"Path parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the `relativeURI` template."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"resourceFields":{"type":"array","description":"Resource field definitions for this endpoint","items":{"type":"object","properties":{"type":{"type":"string","enum":["inclusion","exclusion"],"description":"Whether `fields` lists the fields to include or to exclude."},"fields":{"type":"array","description":"Field names the inclusion or exclusion rule applies to.","items":{"type":"string"}},"_httpConnectorResourceId":{"type":"string","format":"objectId","description":"HTTP Connector Resource these field rules apply to."}},"required":["type","fields","_httpConnectorResourceId"]}},"supportedBy":{"type":"object","description":"How the connector framework turns this endpoint into an export or an\nimport: which one it becomes, the fields it pre-configures, and the\nfields the user must still fill in. Each entry's `path` names a setting\nin the connector's form, which is not always a literal path on the\ngenerated export or import.","required":["type"],"properties":{"type":{"type":"string","enum":["import","export"],"description":"Whether this endpoint is consumed as an import or an export. Also\nthe value the nested listing's `supportedByType` filter matches."},"conditions":{"type":"array","description":"Expression-based filters that control when entries in `preConfiguredFields` and `fieldsUserMustSet` apply.","items":{"type":"object","additionalProperties":true}},"preConfiguredFields":{"type":"array","description":"Fields automatically set to predefined values on the generated export or import. Not editable by the user.","items":{"type":"object","additionalProperties":true}},"fieldsUserMustSet":{"type":"array","description":"Fields the user must provide values for on the generated export or import.","items":{"type":"object","additionalProperties":true}},"fieldsToUnset":{"type":"array","description":"Dot-notation paths of fields to remove from the generated export or import configuration.","items":{"type":"string"}},"pathParameterToIdentifyExisting":{"type":"string","description":"Path parameter whose value identifies an existing record in the target application."},"lookupToIdentifyExisting":{"type":"object","description":"Lookup used to determine whether a record already exists in the target application.","properties":{"_httpConnectorEndpointId":{"type":"string","format":"objectId","description":"HTTP Connector Endpoint used to perform the lookup."},"extract":{"type":"string","description":"Path in the lookup response from which to extract the existing record's identifier."}}}}}}},"ResourceResponse":{"type":"object","description":"Response","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource. Format is a 24-character hexadecimal string."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was created. Set automatically and cannot be modified."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was last updated. Changes whenever any property is modified."},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp when the resource was soft-deleted. When null or absent, the resource is active."}},"required":["_id"]}}}} ``` ## List your HTTP Connector Endpoints > 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. ```json {"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"tags":[{"name":"HTTP Connector Endpoints","description":"HTTP Connector Endpoints define the individual API operations (method +\nURI) available under an HTTP Connector Resource. Each endpoint specifies\nits HTTP method, relative URI template, query/path parameter definitions,\nand supported-by rules that control how exports and imports are\npre-configured when users select this endpoint.\n\nManage your own endpoints through `/v1/httpconnectorendpoints` (list,\ncreate) and `/v1/httpconnectorendpoints/{_id}` (get, update, delete).\nThe nested `/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/...`\nroutes are read-only views scoped to one resource that also reach\nendpoints published by other partners; an endpoint read through either\nroute is the same object.\n\n## HTTP connector endpoint schema\n\n{% openapi-schemas spec=\"httpconnectorendpoint\" schemas=\"HTTPConnectorEndpoint\" grouped=\"true\" %}"}],"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"},{"url":"https://api.au.integrator.io","description":"Production (AU region)"},{"url":"https://api.ca.integrator.io","description":"Production (CA region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"After":{"name":"after","in":"query","required":false,"description":"Opaque cursor for forward pagination. Pass the value from the `Link`\nresponse header (`rel=\"next\"`) to fetch the next page.","schema":{"type":"string"}}},"schemas":{"HTTPConnectorEndpoint":{"type":"object","required":["_id","name","method","relativeURI","published","isBlob","isMappingRequired","mergePostBodyToPagingPostBody","_httpConnectorResourceIds","createdAt","lastModified"],"description":"HTTP Connector Endpoint as returned by `GET /v1/httpconnectorendpoints`,\n`GET /v1/httpconnectorendpoints/{_id}`, and the nested\n`GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}`\n— all three return the same object. Optional fields that were never set\nare absent.","allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"},{"$ref":"#/components/schemas/ResourceResponse"},{"type":"object","properties":{"metadata":{"type":"object","description":"Endpoint metadata used by Data Intelligence tooling. Absent when\nnever set; Data Intelligence attributes can only be stored on a\npublished endpoint.","properties":{"di":{"type":"object","description":"Data Intelligence attributes for this endpoint.","properties":{"isListEndpoint":{"type":"boolean","description":"When true, the endpoint returns a list of records rather than a single record."},"responseFields":{"type":"array","description":"Fields Data Intelligence expects in this endpoint's response records.","items":{"type":"object","properties":{"id":{"type":"string","description":"Field path within a response record."},"dataType":{"type":"string","description":"Data type of the field."}}}}}}}}}}]},"HTTPConnectorEndpointBase":{"type":"object","description":"Writable fields shared by the request and response schemas.","properties":{"name":{"type":"string","description":"Human-readable name for this endpoint, shown when users pick an operation.","maxLength":255},"description":{"type":"string","description":"Help text describing what the endpoint does. Absent when never set.","maxLength":10240},"published":{"type":"boolean","default":false,"description":"When true, this endpoint is visible in the connector's published\ncatalog. Kept as stored when omitted on PUT."},"isBlob":{"type":"boolean","default":false,"description":"When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT."},"isMappingRequired":{"type":"boolean","default":false,"description":"When true, users must configure field mappings before an import built on this endpoint can run."},"_httpConnectorResourceIds":{"type":"array","minItems":1,"description":"HTTP Connector Resources this endpoint is listed under. Each id must\nbe a resource owned by the caller's account; the endpoint appears in\nthe nested listing of every resource named here.","items":{"type":"string","format":"objectId"}},"method":{"type":"string","enum":["GET","PUT","POST","PATCH","DELETE","HEAD"],"description":"HTTP method for this endpoint. Required on save; lowercase input is\nuppercased automatically."},"relativeURI":{"type":"string","description":"Relative URI template for this endpoint"},"mergePostBodyToPagingPostBody":{"type":"boolean","description":"When true, merges the postBody into pagingPostBody for paginated requests.","default":false},"queryParameters":{"type":"array","description":"Query parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the request query string."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"pathParameters":{"type":"array","description":"Path parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the `relativeURI` template."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"resourceFields":{"type":"array","description":"Resource field definitions for this endpoint","items":{"type":"object","properties":{"type":{"type":"string","enum":["inclusion","exclusion"],"description":"Whether `fields` lists the fields to include or to exclude."},"fields":{"type":"array","description":"Field names the inclusion or exclusion rule applies to.","items":{"type":"string"}},"_httpConnectorResourceId":{"type":"string","format":"objectId","description":"HTTP Connector Resource these field rules apply to."}},"required":["type","fields","_httpConnectorResourceId"]}},"supportedBy":{"type":"object","description":"How the connector framework turns this endpoint into an export or an\nimport: which one it becomes, the fields it pre-configures, and the\nfields the user must still fill in. Each entry's `path` names a setting\nin the connector's form, which is not always a literal path on the\ngenerated export or import.","required":["type"],"properties":{"type":{"type":"string","enum":["import","export"],"description":"Whether this endpoint is consumed as an import or an export. Also\nthe value the nested listing's `supportedByType` filter matches."},"conditions":{"type":"array","description":"Expression-based filters that control when entries in `preConfiguredFields` and `fieldsUserMustSet` apply.","items":{"type":"object","additionalProperties":true}},"preConfiguredFields":{"type":"array","description":"Fields automatically set to predefined values on the generated export or import. Not editable by the user.","items":{"type":"object","additionalProperties":true}},"fieldsUserMustSet":{"type":"array","description":"Fields the user must provide values for on the generated export or import.","items":{"type":"object","additionalProperties":true}},"fieldsToUnset":{"type":"array","description":"Dot-notation paths of fields to remove from the generated export or import configuration.","items":{"type":"string"}},"pathParameterToIdentifyExisting":{"type":"string","description":"Path parameter whose value identifies an existing record in the target application."},"lookupToIdentifyExisting":{"type":"object","description":"Lookup used to determine whether a record already exists in the target application.","properties":{"_httpConnectorEndpointId":{"type":"string","format":"objectId","description":"HTTP Connector Endpoint used to perform the lookup."},"extract":{"type":"string","description":"Path in the lookup response from which to extract the existing record's identifier."}}}}}}},"ResourceResponse":{"type":"object","description":"Response","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource. Format is a 24-character hexadecimal string."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was created. Set automatically and cannot be modified."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was last updated. Changes whenever any property is modified."},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp when the resource was soft-deleted. When null or absent, the resource is active."}},"required":["_id"]},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectorendpoints":{"get":{"operationId":"listOwnHttpConnectorEndpoints","tags":["HTTP Connector Endpoints"],"summary":"List your HTTP Connector Endpoints","description":"Returns the full HTTP Connector Endpoints owned by the account, across all\nof its connectors and resources, sorted by name. This is the canonical\nCRUD listing; to browse the endpoints of one resource — including\nendpoints published by other partners — use the scoped\n`GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/httpconnectorendpoints`,\nwhich returns an abridged shape.","parameters":[{"name":"limit","in":"query","description":"Maximum number of records to return per page.","schema":{"type":"integer","minimum":1}},{"$ref":"#/components/parameters/After"}],"responses":{"200":{"description":"Array of the account's HTTP Connector Endpoints.","headers":{"Link":{"description":"RFC-5988 pagination links. When more pages remain, includes a\n`<...>; rel=\"next\"` entry; absent on the final page.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HTTPConnectorEndpoint"}}}}},"204":{"description":"The account owns no HTTP Connector Endpoints."},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"}}}}}} ``` ## Create an HTTP Connector Endpoint > 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\`. ```json {"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"tags":[{"name":"HTTP Connector Endpoints","description":"HTTP Connector Endpoints define the individual API operations (method +\nURI) available under an HTTP Connector Resource. Each endpoint specifies\nits HTTP method, relative URI template, query/path parameter definitions,\nand supported-by rules that control how exports and imports are\npre-configured when users select this endpoint.\n\nManage your own endpoints through `/v1/httpconnectorendpoints` (list,\ncreate) and `/v1/httpconnectorendpoints/{_id}` (get, update, delete).\nThe nested `/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/...`\nroutes are read-only views scoped to one resource that also reach\nendpoints published by other partners; an endpoint read through either\nroute is the same object.\n\n## HTTP connector endpoint schema\n\n{% openapi-schemas spec=\"httpconnectorendpoint\" schemas=\"HTTPConnectorEndpoint\" grouped=\"true\" %}"}],"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"},{"url":"https://api.au.integrator.io","description":"Production (AU region)"},{"url":"https://api.ca.integrator.io","description":"Production (CA region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Request":{"type":"object","description":"Fields for creating or updating an HTTP Connector Endpoint through\n`POST /v1/httpconnectorendpoints` and `PUT /v1/httpconnectorendpoints/{_id}`.\nPUT replaces the whole document — omitted optional fields are cleared\n(`isMappingRequired` and `mergePostBodyToPagingPostBody` revert to\n`false`), except `published` and `isBlob`, which keep their stored values.","required":["name","method","relativeURI","_httpConnectorResourceIds","supportedBy"],"allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"}]},"HTTPConnectorEndpointBase":{"type":"object","description":"Writable fields shared by the request and response schemas.","properties":{"name":{"type":"string","description":"Human-readable name for this endpoint, shown when users pick an operation.","maxLength":255},"description":{"type":"string","description":"Help text describing what the endpoint does. Absent when never set.","maxLength":10240},"published":{"type":"boolean","default":false,"description":"When true, this endpoint is visible in the connector's published\ncatalog. Kept as stored when omitted on PUT."},"isBlob":{"type":"boolean","default":false,"description":"When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT."},"isMappingRequired":{"type":"boolean","default":false,"description":"When true, users must configure field mappings before an import built on this endpoint can run."},"_httpConnectorResourceIds":{"type":"array","minItems":1,"description":"HTTP Connector Resources this endpoint is listed under. Each id must\nbe a resource owned by the caller's account; the endpoint appears in\nthe nested listing of every resource named here.","items":{"type":"string","format":"objectId"}},"method":{"type":"string","enum":["GET","PUT","POST","PATCH","DELETE","HEAD"],"description":"HTTP method for this endpoint. Required on save; lowercase input is\nuppercased automatically."},"relativeURI":{"type":"string","description":"Relative URI template for this endpoint"},"mergePostBodyToPagingPostBody":{"type":"boolean","description":"When true, merges the postBody into pagingPostBody for paginated requests.","default":false},"queryParameters":{"type":"array","description":"Query parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the request query string."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"pathParameters":{"type":"array","description":"Path parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the `relativeURI` template."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"resourceFields":{"type":"array","description":"Resource field definitions for this endpoint","items":{"type":"object","properties":{"type":{"type":"string","enum":["inclusion","exclusion"],"description":"Whether `fields` lists the fields to include or to exclude."},"fields":{"type":"array","description":"Field names the inclusion or exclusion rule applies to.","items":{"type":"string"}},"_httpConnectorResourceId":{"type":"string","format":"objectId","description":"HTTP Connector Resource these field rules apply to."}},"required":["type","fields","_httpConnectorResourceId"]}},"supportedBy":{"type":"object","description":"How the connector framework turns this endpoint into an export or an\nimport: which one it becomes, the fields it pre-configures, and the\nfields the user must still fill in. Each entry's `path` names a setting\nin the connector's form, which is not always a literal path on the\ngenerated export or import.","required":["type"],"properties":{"type":{"type":"string","enum":["import","export"],"description":"Whether this endpoint is consumed as an import or an export. Also\nthe value the nested listing's `supportedByType` filter matches."},"conditions":{"type":"array","description":"Expression-based filters that control when entries in `preConfiguredFields` and `fieldsUserMustSet` apply.","items":{"type":"object","additionalProperties":true}},"preConfiguredFields":{"type":"array","description":"Fields automatically set to predefined values on the generated export or import. Not editable by the user.","items":{"type":"object","additionalProperties":true}},"fieldsUserMustSet":{"type":"array","description":"Fields the user must provide values for on the generated export or import.","items":{"type":"object","additionalProperties":true}},"fieldsToUnset":{"type":"array","description":"Dot-notation paths of fields to remove from the generated export or import configuration.","items":{"type":"string"}},"pathParameterToIdentifyExisting":{"type":"string","description":"Path parameter whose value identifies an existing record in the target application."},"lookupToIdentifyExisting":{"type":"object","description":"Lookup used to determine whether a record already exists in the target application.","properties":{"_httpConnectorEndpointId":{"type":"string","format":"objectId","description":"HTTP Connector Endpoint used to perform the lookup."},"extract":{"type":"string","description":"Path in the lookup response from which to extract the existing record's identifier."}}}}}}},"HTTPConnectorEndpoint":{"type":"object","required":["_id","name","method","relativeURI","published","isBlob","isMappingRequired","mergePostBodyToPagingPostBody","_httpConnectorResourceIds","createdAt","lastModified"],"description":"HTTP Connector Endpoint as returned by `GET /v1/httpconnectorendpoints`,\n`GET /v1/httpconnectorendpoints/{_id}`, and the nested\n`GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}`\n— all three return the same object. Optional fields that were never set\nare absent.","allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"},{"$ref":"#/components/schemas/ResourceResponse"},{"type":"object","properties":{"metadata":{"type":"object","description":"Endpoint metadata used by Data Intelligence tooling. Absent when\nnever set; Data Intelligence attributes can only be stored on a\npublished endpoint.","properties":{"di":{"type":"object","description":"Data Intelligence attributes for this endpoint.","properties":{"isListEndpoint":{"type":"boolean","description":"When true, the endpoint returns a list of records rather than a single record."},"responseFields":{"type":"array","description":"Fields Data Intelligence expects in this endpoint's response records.","items":{"type":"object","properties":{"id":{"type":"string","description":"Field path within a response record."},"dataType":{"type":"string","description":"Data type of the field."}}}}}}}}}}]},"ResourceResponse":{"type":"object","description":"Response","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource. Format is a 24-character hexadecimal string."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was created. Set automatically and cannot be modified."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was last updated. Changes whenever any property is modified."},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp when the resource was soft-deleted. When null or absent, the resource is active."}},"required":["_id"]},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"400-bad-request":{"description":"Bad request. The server could not understand the request because of malformed syntax or invalid parameters.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectorendpoints":{"post":{"operationId":"createHttpConnectorEndpoint","tags":["HTTP Connector Endpoints"],"summary":"Create an HTTP Connector Endpoint","description":"Creates an operation under one or more of your HTTP Connector Resources.\nCreate the resource first (`POST /v1/httpconnectorresources`) and list\nits id in `_httpConnectorResourceIds`; `supportedBy.type` decides whether\nusers build exports or imports on the endpoint. `method` is uppercased on\nsave, so `get` is stored as `GET`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"responses":{"201":{"description":"Created endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPConnectorEndpoint"}}}},"400":{"$ref":"#/components/responses/400-bad-request"},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"422":{"description":"A required field is missing, `method` or `supportedBy.type` is\noutside its enum, a referenced resource or lookup endpoint is not\nyours, or Data Intelligence metadata was sent for an unpublished\nendpoint. Several problems are reported together.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ``` ## Get one of your HTTP Connector Endpoints > 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. ```json {"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"tags":[{"name":"HTTP Connector Endpoints","description":"HTTP Connector Endpoints define the individual API operations (method +\nURI) available under an HTTP Connector Resource. Each endpoint specifies\nits HTTP method, relative URI template, query/path parameter definitions,\nand supported-by rules that control how exports and imports are\npre-configured when users select this endpoint.\n\nManage your own endpoints through `/v1/httpconnectorendpoints` (list,\ncreate) and `/v1/httpconnectorendpoints/{_id}` (get, update, delete).\nThe nested `/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/...`\nroutes are read-only views scoped to one resource that also reach\nendpoints published by other partners; an endpoint read through either\nroute is the same object.\n\n## HTTP connector endpoint schema\n\n{% openapi-schemas spec=\"httpconnectorendpoint\" schemas=\"HTTPConnectorEndpoint\" grouped=\"true\" %}"}],"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"},{"url":"https://api.au.integrator.io","description":"Production (AU region)"},{"url":"https://api.ca.integrator.io","description":"Production (CA region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"HTTPConnectorEndpoint":{"type":"object","required":["_id","name","method","relativeURI","published","isBlob","isMappingRequired","mergePostBodyToPagingPostBody","_httpConnectorResourceIds","createdAt","lastModified"],"description":"HTTP Connector Endpoint as returned by `GET /v1/httpconnectorendpoints`,\n`GET /v1/httpconnectorendpoints/{_id}`, and the nested\n`GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}`\n— all three return the same object. Optional fields that were never set\nare absent.","allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"},{"$ref":"#/components/schemas/ResourceResponse"},{"type":"object","properties":{"metadata":{"type":"object","description":"Endpoint metadata used by Data Intelligence tooling. Absent when\nnever set; Data Intelligence attributes can only be stored on a\npublished endpoint.","properties":{"di":{"type":"object","description":"Data Intelligence attributes for this endpoint.","properties":{"isListEndpoint":{"type":"boolean","description":"When true, the endpoint returns a list of records rather than a single record."},"responseFields":{"type":"array","description":"Fields Data Intelligence expects in this endpoint's response records.","items":{"type":"object","properties":{"id":{"type":"string","description":"Field path within a response record."},"dataType":{"type":"string","description":"Data type of the field."}}}}}}}}}}]},"HTTPConnectorEndpointBase":{"type":"object","description":"Writable fields shared by the request and response schemas.","properties":{"name":{"type":"string","description":"Human-readable name for this endpoint, shown when users pick an operation.","maxLength":255},"description":{"type":"string","description":"Help text describing what the endpoint does. Absent when never set.","maxLength":10240},"published":{"type":"boolean","default":false,"description":"When true, this endpoint is visible in the connector's published\ncatalog. Kept as stored when omitted on PUT."},"isBlob":{"type":"boolean","default":false,"description":"When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT."},"isMappingRequired":{"type":"boolean","default":false,"description":"When true, users must configure field mappings before an import built on this endpoint can run."},"_httpConnectorResourceIds":{"type":"array","minItems":1,"description":"HTTP Connector Resources this endpoint is listed under. Each id must\nbe a resource owned by the caller's account; the endpoint appears in\nthe nested listing of every resource named here.","items":{"type":"string","format":"objectId"}},"method":{"type":"string","enum":["GET","PUT","POST","PATCH","DELETE","HEAD"],"description":"HTTP method for this endpoint. Required on save; lowercase input is\nuppercased automatically."},"relativeURI":{"type":"string","description":"Relative URI template for this endpoint"},"mergePostBodyToPagingPostBody":{"type":"boolean","description":"When true, merges the postBody into pagingPostBody for paginated requests.","default":false},"queryParameters":{"type":"array","description":"Query parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the request query string."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"pathParameters":{"type":"array","description":"Path parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the `relativeURI` template."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"resourceFields":{"type":"array","description":"Resource field definitions for this endpoint","items":{"type":"object","properties":{"type":{"type":"string","enum":["inclusion","exclusion"],"description":"Whether `fields` lists the fields to include or to exclude."},"fields":{"type":"array","description":"Field names the inclusion or exclusion rule applies to.","items":{"type":"string"}},"_httpConnectorResourceId":{"type":"string","format":"objectId","description":"HTTP Connector Resource these field rules apply to."}},"required":["type","fields","_httpConnectorResourceId"]}},"supportedBy":{"type":"object","description":"How the connector framework turns this endpoint into an export or an\nimport: which one it becomes, the fields it pre-configures, and the\nfields the user must still fill in. Each entry's `path` names a setting\nin the connector's form, which is not always a literal path on the\ngenerated export or import.","required":["type"],"properties":{"type":{"type":"string","enum":["import","export"],"description":"Whether this endpoint is consumed as an import or an export. Also\nthe value the nested listing's `supportedByType` filter matches."},"conditions":{"type":"array","description":"Expression-based filters that control when entries in `preConfiguredFields` and `fieldsUserMustSet` apply.","items":{"type":"object","additionalProperties":true}},"preConfiguredFields":{"type":"array","description":"Fields automatically set to predefined values on the generated export or import. Not editable by the user.","items":{"type":"object","additionalProperties":true}},"fieldsUserMustSet":{"type":"array","description":"Fields the user must provide values for on the generated export or import.","items":{"type":"object","additionalProperties":true}},"fieldsToUnset":{"type":"array","description":"Dot-notation paths of fields to remove from the generated export or import configuration.","items":{"type":"string"}},"pathParameterToIdentifyExisting":{"type":"string","description":"Path parameter whose value identifies an existing record in the target application."},"lookupToIdentifyExisting":{"type":"object","description":"Lookup used to determine whether a record already exists in the target application.","properties":{"_httpConnectorEndpointId":{"type":"string","format":"objectId","description":"HTTP Connector Endpoint used to perform the lookup."},"extract":{"type":"string","description":"Path in the lookup response from which to extract the existing record's identifier."}}}}}}},"ResourceResponse":{"type":"object","description":"Response","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource. Format is a 24-character hexadecimal string."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was created. Set automatically and cannot be modified."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was last updated. Changes whenever any property is modified."},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp when the resource was soft-deleted. When null or absent, the resource is active."}},"required":["_id"]},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectorendpoints/{_id}":{"get":{"operationId":"getOwnHttpConnectorEndpointById","tags":["HTTP Connector Endpoints"],"summary":"Get one of your HTTP Connector Endpoints","description":"Returns the full endpoint. The nested\n`GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}`\nreturns the identical object and additionally reaches endpoints published\nby other partners; this route is limited to endpoints the account owns.","parameters":[{"in":"path","name":"_id","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Endpoint ID."}],"responses":{"200":{"description":"The endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPConnectorEndpoint"}}}},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"404":{"description":"No endpoint with this id is owned by the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ``` ## Update an HTTP Connector Endpoint > 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. ```json {"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"tags":[{"name":"HTTP Connector Endpoints","description":"HTTP Connector Endpoints define the individual API operations (method +\nURI) available under an HTTP Connector Resource. Each endpoint specifies\nits HTTP method, relative URI template, query/path parameter definitions,\nand supported-by rules that control how exports and imports are\npre-configured when users select this endpoint.\n\nManage your own endpoints through `/v1/httpconnectorendpoints` (list,\ncreate) and `/v1/httpconnectorendpoints/{_id}` (get, update, delete).\nThe nested `/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/...`\nroutes are read-only views scoped to one resource that also reach\nendpoints published by other partners; an endpoint read through either\nroute is the same object.\n\n## HTTP connector endpoint schema\n\n{% openapi-schemas spec=\"httpconnectorendpoint\" schemas=\"HTTPConnectorEndpoint\" grouped=\"true\" %}"}],"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"},{"url":"https://api.au.integrator.io","description":"Production (AU region)"},{"url":"https://api.ca.integrator.io","description":"Production (CA region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Request":{"type":"object","description":"Fields for creating or updating an HTTP Connector Endpoint through\n`POST /v1/httpconnectorendpoints` and `PUT /v1/httpconnectorendpoints/{_id}`.\nPUT replaces the whole document — omitted optional fields are cleared\n(`isMappingRequired` and `mergePostBodyToPagingPostBody` revert to\n`false`), except `published` and `isBlob`, which keep their stored values.","required":["name","method","relativeURI","_httpConnectorResourceIds","supportedBy"],"allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"}]},"HTTPConnectorEndpointBase":{"type":"object","description":"Writable fields shared by the request and response schemas.","properties":{"name":{"type":"string","description":"Human-readable name for this endpoint, shown when users pick an operation.","maxLength":255},"description":{"type":"string","description":"Help text describing what the endpoint does. Absent when never set.","maxLength":10240},"published":{"type":"boolean","default":false,"description":"When true, this endpoint is visible in the connector's published\ncatalog. Kept as stored when omitted on PUT."},"isBlob":{"type":"boolean","default":false,"description":"When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT."},"isMappingRequired":{"type":"boolean","default":false,"description":"When true, users must configure field mappings before an import built on this endpoint can run."},"_httpConnectorResourceIds":{"type":"array","minItems":1,"description":"HTTP Connector Resources this endpoint is listed under. Each id must\nbe a resource owned by the caller's account; the endpoint appears in\nthe nested listing of every resource named here.","items":{"type":"string","format":"objectId"}},"method":{"type":"string","enum":["GET","PUT","POST","PATCH","DELETE","HEAD"],"description":"HTTP method for this endpoint. Required on save; lowercase input is\nuppercased automatically."},"relativeURI":{"type":"string","description":"Relative URI template for this endpoint"},"mergePostBodyToPagingPostBody":{"type":"boolean","description":"When true, merges the postBody into pagingPostBody for paginated requests.","default":false},"queryParameters":{"type":"array","description":"Query parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the request query string."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"pathParameters":{"type":"array","description":"Path parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the `relativeURI` template."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"resourceFields":{"type":"array","description":"Resource field definitions for this endpoint","items":{"type":"object","properties":{"type":{"type":"string","enum":["inclusion","exclusion"],"description":"Whether `fields` lists the fields to include or to exclude."},"fields":{"type":"array","description":"Field names the inclusion or exclusion rule applies to.","items":{"type":"string"}},"_httpConnectorResourceId":{"type":"string","format":"objectId","description":"HTTP Connector Resource these field rules apply to."}},"required":["type","fields","_httpConnectorResourceId"]}},"supportedBy":{"type":"object","description":"How the connector framework turns this endpoint into an export or an\nimport: which one it becomes, the fields it pre-configures, and the\nfields the user must still fill in. Each entry's `path` names a setting\nin the connector's form, which is not always a literal path on the\ngenerated export or import.","required":["type"],"properties":{"type":{"type":"string","enum":["import","export"],"description":"Whether this endpoint is consumed as an import or an export. Also\nthe value the nested listing's `supportedByType` filter matches."},"conditions":{"type":"array","description":"Expression-based filters that control when entries in `preConfiguredFields` and `fieldsUserMustSet` apply.","items":{"type":"object","additionalProperties":true}},"preConfiguredFields":{"type":"array","description":"Fields automatically set to predefined values on the generated export or import. Not editable by the user.","items":{"type":"object","additionalProperties":true}},"fieldsUserMustSet":{"type":"array","description":"Fields the user must provide values for on the generated export or import.","items":{"type":"object","additionalProperties":true}},"fieldsToUnset":{"type":"array","description":"Dot-notation paths of fields to remove from the generated export or import configuration.","items":{"type":"string"}},"pathParameterToIdentifyExisting":{"type":"string","description":"Path parameter whose value identifies an existing record in the target application."},"lookupToIdentifyExisting":{"type":"object","description":"Lookup used to determine whether a record already exists in the target application.","properties":{"_httpConnectorEndpointId":{"type":"string","format":"objectId","description":"HTTP Connector Endpoint used to perform the lookup."},"extract":{"type":"string","description":"Path in the lookup response from which to extract the existing record's identifier."}}}}}}},"HTTPConnectorEndpoint":{"type":"object","required":["_id","name","method","relativeURI","published","isBlob","isMappingRequired","mergePostBodyToPagingPostBody","_httpConnectorResourceIds","createdAt","lastModified"],"description":"HTTP Connector Endpoint as returned by `GET /v1/httpconnectorendpoints`,\n`GET /v1/httpconnectorendpoints/{_id}`, and the nested\n`GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}`\n— all three return the same object. Optional fields that were never set\nare absent.","allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"},{"$ref":"#/components/schemas/ResourceResponse"},{"type":"object","properties":{"metadata":{"type":"object","description":"Endpoint metadata used by Data Intelligence tooling. Absent when\nnever set; Data Intelligence attributes can only be stored on a\npublished endpoint.","properties":{"di":{"type":"object","description":"Data Intelligence attributes for this endpoint.","properties":{"isListEndpoint":{"type":"boolean","description":"When true, the endpoint returns a list of records rather than a single record."},"responseFields":{"type":"array","description":"Fields Data Intelligence expects in this endpoint's response records.","items":{"type":"object","properties":{"id":{"type":"string","description":"Field path within a response record."},"dataType":{"type":"string","description":"Data type of the field."}}}}}}}}}}]},"ResourceResponse":{"type":"object","description":"Response","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource. Format is a 24-character hexadecimal string."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was created. Set automatically and cannot be modified."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was last updated. Changes whenever any property is modified."},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp when the resource was soft-deleted. When null or absent, the resource is active."}},"required":["_id"]},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"400-bad-request":{"description":"Bad request. The server could not understand the request because of malformed syntax or invalid parameters.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404-not-found":{"description":"Not found. The requested resource does not exist or is not visible to the caller.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422-unprocessable-entity":{"description":"Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectorendpoints/{_id}":{"put":{"operationId":"updateHttpConnectorEndpoint","tags":["HTTP Connector Endpoints"],"summary":"Update an HTTP Connector Endpoint","description":"Replaces the endpoint with the request body. Send the complete document —\n`description`, `queryParameters`, `pathParameters`, `resourceFields`, and\nthe `supportedBy` details are cleared when left out and\n`isMappingRequired` / `mergePostBodyToPagingPostBody` revert to `false`,\nwhile `published` and `isBlob` keep their stored values when omitted. The\nfive create-time requireds are required on every PUT.","parameters":[{"in":"path","name":"_id","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Endpoint ID."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"responses":{"200":{"description":"Updated endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPConnectorEndpoint"}}}},"400":{"$ref":"#/components/responses/400-bad-request"},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"404":{"$ref":"#/components/responses/404-not-found"},"422":{"$ref":"#/components/responses/422-unprocessable-entity"}}}}}} ``` ## Delete an HTTP Connector Endpoint > 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. ```json {"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"tags":[{"name":"HTTP Connector Endpoints","description":"HTTP Connector Endpoints define the individual API operations (method +\nURI) available under an HTTP Connector Resource. Each endpoint specifies\nits HTTP method, relative URI template, query/path parameter definitions,\nand supported-by rules that control how exports and imports are\npre-configured when users select this endpoint.\n\nManage your own endpoints through `/v1/httpconnectorendpoints` (list,\ncreate) and `/v1/httpconnectorendpoints/{_id}` (get, update, delete).\nThe nested `/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/...`\nroutes are read-only views scoped to one resource that also reach\nendpoints published by other partners; an endpoint read through either\nroute is the same object.\n\n## HTTP connector endpoint schema\n\n{% openapi-schemas spec=\"httpconnectorendpoint\" schemas=\"HTTPConnectorEndpoint\" grouped=\"true\" %}"}],"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"},{"url":"https://api.au.integrator.io","description":"Production (AU region)"},{"url":"https://api.ca.integrator.io","description":"Production (CA region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"responses":{"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404-not-found":{"description":"Not found. The requested resource does not exist or is not visible to the caller.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}}},"paths":{"/v1/httpconnectorendpoints/{_id}":{"delete":{"operationId":"deleteHttpConnectorEndpoint","tags":["HTTP Connector Endpoints"],"summary":"Delete an HTTP Connector Endpoint","description":"Deletes the endpoint. Refused while another endpoint still names it in\n`supportedBy.lookupToIdentifyExisting._httpConnectorEndpointId` — update\nor delete that endpoint first. Not recoverable through the recycle bin.","parameters":[{"in":"path","name":"_id","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Endpoint ID."}],"responses":{"204":{"description":"Endpoint deleted."},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"404":{"$ref":"#/components/responses/404-not-found"},"422":{"description":"Another endpoint's lookup still references this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ``` ## List a resource's HTTP Connector Endpoints > 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. ```json {"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"tags":[{"name":"HTTP Connector Endpoints","description":"HTTP Connector Endpoints define the individual API operations (method +\nURI) available under an HTTP Connector Resource. Each endpoint specifies\nits HTTP method, relative URI template, query/path parameter definitions,\nand supported-by rules that control how exports and imports are\npre-configured when users select this endpoint.\n\nManage your own endpoints through `/v1/httpconnectorendpoints` (list,\ncreate) and `/v1/httpconnectorendpoints/{_id}` (get, update, delete).\nThe nested `/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/...`\nroutes are read-only views scoped to one resource that also reach\nendpoints published by other partners; an endpoint read through either\nroute is the same object.\n\n## HTTP connector endpoint schema\n\n{% openapi-schemas spec=\"httpconnectorendpoint\" schemas=\"HTTPConnectorEndpoint\" grouped=\"true\" %}"}],"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"},{"url":"https://api.au.integrator.io","description":"Production (AU region)"},{"url":"https://api.ca.integrator.io","description":"Production (CA region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"ListItem":{"type":"object","description":"Abridged HTTP Connector Endpoint returned by the nested\n`GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/httpconnectorendpoints`\ncatalog listing. Includes identity, description, and timestamps only;\nfetch the full object by id for `method`, `relativeURI`, and\n`supportedBy`.","required":["_id","name","createdAt","lastModified"],"properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the endpoint."},"name":{"type":"string","description":"Human-readable name for this endpoint."},"description":{"type":"string","description":"Help text describing what the endpoint does. Absent when never set."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the endpoint was created."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the endpoint was last updated. Changes on every PUT."}}},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}}}},"paths":{"/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/httpconnectorendpoints":{"get":{"operationId":"listHttpConnectorEndpoints","tags":["HTTP Connector Endpoints"],"summary":"List a resource's HTTP Connector Endpoints","description":"Returns the endpoints defined under the given HTTP Connector Resource —\nyour own and, for resources published by other partners, their published\nendpoints — sorted by name. The whole list is returned in one response.\n\nThe shape is abridged: only `_id`, `name`, `description`, `createdAt`,\nand `lastModified` are returned. Use the by-ID endpoint for the full\nobject including `method`, `relativeURI`, and `supportedBy`, or\n`GET /v1/httpconnectorendpoints` for the full shape of everything your\naccount owns.","parameters":[{"in":"path","name":"_httpConnectorId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector ID."},{"in":"path","name":"_httpConnectorResourceId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Resource ID."},{"in":"query","name":"supportedByType","schema":{"type":"string","enum":["import","export"]},"description":"Return only endpoints whose `supportedBy.type` matches."},{"in":"query","name":"publishedOnly","schema":{"type":"boolean","default":false},"description":"When true, returns only published endpoints. The connector must be\npublished as well, otherwise the request fails with 404."}],"responses":{"200":{"description":"Abridged endpoints of the resource.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}}}}},"204":{"description":"No endpoints exist for this resource (or none match the filter)."},"401":{"$ref":"#/components/responses/401-unauthorized"},"404":{"description":"The connector or resource does not exist, or is neither yours nor\npublished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ``` ## Get an HTTP connector endpoint > 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. ```json {"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"tags":[{"name":"HTTP Connector Endpoints","description":"HTTP Connector Endpoints define the individual API operations (method +\nURI) available under an HTTP Connector Resource. Each endpoint specifies\nits HTTP method, relative URI template, query/path parameter definitions,\nand supported-by rules that control how exports and imports are\npre-configured when users select this endpoint.\n\nManage your own endpoints through `/v1/httpconnectorendpoints` (list,\ncreate) and `/v1/httpconnectorendpoints/{_id}` (get, update, delete).\nThe nested `/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/...`\nroutes are read-only views scoped to one resource that also reach\nendpoints published by other partners; an endpoint read through either\nroute is the same object.\n\n## HTTP connector endpoint schema\n\n{% openapi-schemas spec=\"httpconnectorendpoint\" schemas=\"HTTPConnectorEndpoint\" grouped=\"true\" %}"}],"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"},{"url":"https://api.au.integrator.io","description":"Production (AU region)"},{"url":"https://api.ca.integrator.io","description":"Production (CA region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"HTTPConnectorEndpoint":{"type":"object","required":["_id","name","method","relativeURI","published","isBlob","isMappingRequired","mergePostBodyToPagingPostBody","_httpConnectorResourceIds","createdAt","lastModified"],"description":"HTTP Connector Endpoint as returned by `GET /v1/httpconnectorendpoints`,\n`GET /v1/httpconnectorendpoints/{_id}`, and the nested\n`GET /v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}`\n— all three return the same object. Optional fields that were never set\nare absent.","allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"},{"$ref":"#/components/schemas/ResourceResponse"},{"type":"object","properties":{"metadata":{"type":"object","description":"Endpoint metadata used by Data Intelligence tooling. Absent when\nnever set; Data Intelligence attributes can only be stored on a\npublished endpoint.","properties":{"di":{"type":"object","description":"Data Intelligence attributes for this endpoint.","properties":{"isListEndpoint":{"type":"boolean","description":"When true, the endpoint returns a list of records rather than a single record."},"responseFields":{"type":"array","description":"Fields Data Intelligence expects in this endpoint's response records.","items":{"type":"object","properties":{"id":{"type":"string","description":"Field path within a response record."},"dataType":{"type":"string","description":"Data type of the field."}}}}}}}}}}]},"HTTPConnectorEndpointBase":{"type":"object","description":"Writable fields shared by the request and response schemas.","properties":{"name":{"type":"string","description":"Human-readable name for this endpoint, shown when users pick an operation.","maxLength":255},"description":{"type":"string","description":"Help text describing what the endpoint does. Absent when never set.","maxLength":10240},"published":{"type":"boolean","default":false,"description":"When true, this endpoint is visible in the connector's published\ncatalog. Kept as stored when omitted on PUT."},"isBlob":{"type":"boolean","default":false,"description":"When true, this endpoint transfers binary (blob) content instead of records. Kept as stored when omitted on PUT."},"isMappingRequired":{"type":"boolean","default":false,"description":"When true, users must configure field mappings before an import built on this endpoint can run."},"_httpConnectorResourceIds":{"type":"array","minItems":1,"description":"HTTP Connector Resources this endpoint is listed under. Each id must\nbe a resource owned by the caller's account; the endpoint appears in\nthe nested listing of every resource named here.","items":{"type":"string","format":"objectId"}},"method":{"type":"string","enum":["GET","PUT","POST","PATCH","DELETE","HEAD"],"description":"HTTP method for this endpoint. Required on save; lowercase input is\nuppercased automatically."},"relativeURI":{"type":"string","description":"Relative URI template for this endpoint"},"mergePostBodyToPagingPostBody":{"type":"boolean","description":"When true, merges the postBody into pagingPostBody for paginated requests.","default":false},"queryParameters":{"type":"array","description":"Query parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the request query string."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"pathParameters":{"type":"array","description":"Path parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the `relativeURI` template."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter. Defaults to `name` when omitted."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"default":"input","description":"UI input type used to collect the parameter value. A free-form text input when omitted."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name"]}},"resourceFields":{"type":"array","description":"Resource field definitions for this endpoint","items":{"type":"object","properties":{"type":{"type":"string","enum":["inclusion","exclusion"],"description":"Whether `fields` lists the fields to include or to exclude."},"fields":{"type":"array","description":"Field names the inclusion or exclusion rule applies to.","items":{"type":"string"}},"_httpConnectorResourceId":{"type":"string","format":"objectId","description":"HTTP Connector Resource these field rules apply to."}},"required":["type","fields","_httpConnectorResourceId"]}},"supportedBy":{"type":"object","description":"How the connector framework turns this endpoint into an export or an\nimport: which one it becomes, the fields it pre-configures, and the\nfields the user must still fill in. Each entry's `path` names a setting\nin the connector's form, which is not always a literal path on the\ngenerated export or import.","required":["type"],"properties":{"type":{"type":"string","enum":["import","export"],"description":"Whether this endpoint is consumed as an import or an export. Also\nthe value the nested listing's `supportedByType` filter matches."},"conditions":{"type":"array","description":"Expression-based filters that control when entries in `preConfiguredFields` and `fieldsUserMustSet` apply.","items":{"type":"object","additionalProperties":true}},"preConfiguredFields":{"type":"array","description":"Fields automatically set to predefined values on the generated export or import. Not editable by the user.","items":{"type":"object","additionalProperties":true}},"fieldsUserMustSet":{"type":"array","description":"Fields the user must provide values for on the generated export or import.","items":{"type":"object","additionalProperties":true}},"fieldsToUnset":{"type":"array","description":"Dot-notation paths of fields to remove from the generated export or import configuration.","items":{"type":"string"}},"pathParameterToIdentifyExisting":{"type":"string","description":"Path parameter whose value identifies an existing record in the target application."},"lookupToIdentifyExisting":{"type":"object","description":"Lookup used to determine whether a record already exists in the target application.","properties":{"_httpConnectorEndpointId":{"type":"string","format":"objectId","description":"HTTP Connector Endpoint used to perform the lookup."},"extract":{"type":"string","description":"Path in the lookup response from which to extract the existing record's identifier."}}}}}}},"ResourceResponse":{"type":"object","description":"Response","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource. Format is a 24-character hexadecimal string."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was created. Set automatically and cannot be modified."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was last updated. Changes whenever any property is modified."},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp when the resource was soft-deleted. When null or absent, the resource is active."}},"required":["_id"]},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404-not-found":{"description":"Not found. The requested resource does not exist or is not visible to the caller.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}":{"get":{"operationId":"getHttpConnectorEndpointById","tags":["HTTP Connector Endpoints"],"summary":"Get an HTTP connector endpoint","description":"Retrieves the full HTTP Connector Endpoint including `method`,\n`relativeURI`, `queryParameters`, `pathParameters`, and `supportedBy`\ndetails omitted from the list endpoint — the same object\n`GET /v1/httpconnectorendpoints/{_id}` returns, but this route also\nreaches endpoints published by other partners.","parameters":[{"in":"path","name":"_httpConnectorId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector ID."},{"in":"path","name":"_httpConnectorResourceId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Resource ID."},{"in":"path","name":"_id","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Endpoint ID."}],"responses":{"200":{"description":"HTTP Connector Endpoint retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPConnectorEndpoint"}}}},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"404":{"$ref":"#/components/responses/404-not-found"}}}}}} ```