> 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/http-connector-resources.md).

# HTTP Connector Resources

API for reading HTTP Connector Resource objects in Celigo. HTTP Connector Resources represent logical API resource groupings (e.g. "Account", "Contact", "Order") within an HTTP Connector. Each resource is associated with one or more connector versions and contains HTTP Connector Endpoints that define the available operations.

These endpoints are **read-only** — creating, updating, and deleting HTTP Connector Resources is only available through the Celigo UI (session authentication).

### HTTP connector resource schema

## The HTTPConnectorResource object

```json
{"openapi":"3.2.0","info":{"title":"HTTP Connector Resources","version":"1.0.0"},"components":{"schemas":{"HTTPConnectorResource":{"type":"object","required":["_id","_httpConnectorId","name","published","createdAt","lastModified"],"description":"HTTP Connector Resource object as returned by the API","properties":{"_id":{"type":"string","format":"objectId","description":"Unique identifier for the HTTP Connector Resource","readOnly":true},"name":{"type":"string","description":"Human-readable name for this resource (e.g. \"Account\", \"Contact\", \"Order\")"},"published":{"type":"boolean","description":"When true, this resource is published and visible to users."},"_httpConnectorId":{"type":"string","format":"objectId","description":"Parent HTTP Connector ID. Only present in the detail (by-ID) response,\nomitted from list responses.","readOnly":true},"_versionIds":{"type":"array","description":"Connector version IDs this resource belongs to","items":{"type":"string","format":"objectId"}},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when created","readOnly":true},"lastModified":{"type":"string","format":"date-time","description":"Timestamp when last modified","readOnly":true}}}}}}
```

## List HTTP Connector Resources for a connector

> Returns all resources (logical API groupings) defined under the given\
> HTTP Connector.\
> \
> The list response is abridged — it omits \`published\` and\
> \`\_httpConnectorId\` compared to the detail endpoint. Use\
> \`GET /v1/httpconnectors/{\_httpConnectorId}/{\_id}\` for the full object.\
> \
> Each resource's \`\_id\` doubles as the \`\_httpConnectorResourceId\` path\
> parameter used by the HTTP Connector Endpoints API.

```json
{"openapi":"3.2.0","info":{"title":"HTTP Connector Resources","version":"1.0.0"},"tags":[{"name":"HTTP Connector Resources","description":"API for reading HTTP Connector Resource objects in Celigo.\nHTTP Connector Resources represent logical API resource groupings (e.g. \"Account\",\n\"Contact\", \"Order\") within an HTTP Connector. Each resource is associated with one\nor more connector versions and contains HTTP Connector Endpoints that define the\navailable operations.\n\nThese endpoints are **read-only** — creating, updating, and deleting HTTP Connector\nResources is only available through the Celigo UI (session authentication).\n\n## HTTP connector resource schema\n\n{% openapi-schemas spec=\"httpconnectorresource\" schemas=\"HTTPConnectorResource\" 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":{"ListItem":{"type":"object","description":"Abridged HTTP Connector Resource as returned in list responses. Omits\n`published` and `_httpConnectorId` compared to the detail response.","properties":{"_id":{"type":"string","format":"objectId","description":"Unique identifier","readOnly":true},"name":{"type":"string","description":"Resource name"},"_versionIds":{"type":"array","description":"Connector version IDs this resource belongs to","items":{"type":"string","format":"objectId"}},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when created"},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when last modified"}}},"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"]}}}},"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}/httpconnectorresources":{"get":{"operationId":"listHttpConnectorResources","tags":["HTTP Connector Resources"],"summary":"List HTTP Connector Resources for a connector","description":"Returns all resources (logical API groupings) defined under the given\nHTTP Connector.\n\nThe list response is abridged — it omits `published` and\n`_httpConnectorId` compared to the detail endpoint. Use\n`GET /v1/httpconnectors/{_httpConnectorId}/{_id}` for the full object.\n\nEach resource's `_id` doubles as the `_httpConnectorResourceId` path\nparameter used by the HTTP Connector Endpoints API.","parameters":[{"name":"limit","in":"query","description":"Maximum number of records to return per page.","schema":{"type":"integer","minimum":1}},{"$ref":"#/components/parameters/After"},{"in":"path","name":"_httpConnectorId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector ID"}],"responses":{"200":{"description":"Successfully retrieved list of HTTP Connector Resources","headers":{"Link":{"description":"RFC-5988 pagination links. When more pages remain, includes a `<...>; rel=\"next\"` entry;\nabsent on the final page.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}}}}},"204":{"description":"No resources exist for this connector"},"401":{"$ref":"#/components/responses/401-unauthorized"},"404":{"$ref":"#/components/responses/404-not-found"}}}}}}
```

## Get an HTTP connector resource

> Retrieves a specific HTTP Connector Resource by its unique identifier.\
> \
> The path uses a shortcut form: \`/v1/httpconnectors/{\_httpConnectorId}/{\_id}\`\
> where \`{\_id}\` is the resource ID directly under the connector. The longer\
> form \`/v1/httpconnectors/{\_httpConnectorId}/httpconnectorresources/{\_id}\`\
> is not supported and fails with an \`invalid\_ref\` error.\
> \
> The detail response includes \`published\` and \`\_httpConnectorId\` fields\
> that are omitted from the list endpoint.

```json
{"openapi":"3.2.0","info":{"title":"HTTP Connector Resources","version":"1.0.0"},"tags":[{"name":"HTTP Connector Resources","description":"API for reading HTTP Connector Resource objects in Celigo.\nHTTP Connector Resources represent logical API resource groupings (e.g. \"Account\",\n\"Contact\", \"Order\") within an HTTP Connector. Each resource is associated with one\nor more connector versions and contains HTTP Connector Endpoints that define the\navailable operations.\n\nThese endpoints are **read-only** — creating, updating, and deleting HTTP Connector\nResources is only available through the Celigo UI (session authentication).\n\n## HTTP connector resource schema\n\n{% openapi-schemas spec=\"httpconnectorresource\" schemas=\"HTTPConnectorResource\" 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":{"HTTPConnectorResource":{"type":"object","required":["_id","_httpConnectorId","name","published","createdAt","lastModified"],"description":"HTTP Connector Resource object as returned by the API","properties":{"_id":{"type":"string","format":"objectId","description":"Unique identifier for the HTTP Connector Resource","readOnly":true},"name":{"type":"string","description":"Human-readable name for this resource (e.g. \"Account\", \"Contact\", \"Order\")"},"published":{"type":"boolean","description":"When true, this resource is published and visible to users."},"_httpConnectorId":{"type":"string","format":"objectId","description":"Parent HTTP Connector ID. Only present in the detail (by-ID) response,\nomitted from list responses.","readOnly":true},"_versionIds":{"type":"array","description":"Connector version IDs this resource belongs to","items":{"type":"string","format":"objectId"}},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when created","readOnly":true},"lastModified":{"type":"string","format":"date-time","description":"Timestamp when last modified","readOnly":true}}},"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}/{_id}":{"get":{"operationId":"getHttpConnectorResourceById","tags":["HTTP Connector Resources"],"summary":"Get an HTTP connector resource","description":"Retrieves a specific HTTP Connector Resource by its unique identifier.\n\nThe path uses a shortcut form: `/v1/httpconnectors/{_httpConnectorId}/{_id}`\nwhere `{_id}` is the resource ID directly under the connector. The longer\nform `/v1/httpconnectors/{_httpConnectorId}/httpconnectorresources/{_id}`\nis not supported and fails with an `invalid_ref` error.\n\nThe detail response includes `published` and `_httpConnectorId` fields\nthat are omitted from the list endpoint.","parameters":[{"in":"path","name":"_httpConnectorId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector ID"},{"in":"path","name":"_id","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Resource ID"}],"responses":{"200":{"description":"HTTP Connector Resource retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPConnectorResource"}}}},"400":{"description":"Invalid resource ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"$ref":"#/components/responses/401-unauthorized"},"404":{"description":"Resource not found or not published. Also returned when the\n`_httpConnectorId` is valid but the resource ID doesn't belong to it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.celigo.com/api/api-reference/http-connector-resources.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.