integrations

Get an integration

Get one integration: its site, tools, MCP status, MCP URL and server name.

You can read a public integration or one your team's list holds. An integration key reaches only its own.

get/v1/integrations/{id}

Request

  • Base URL: https://api.pomerado.ai
  • URL: https://api.pomerado.ai/v1/integrations/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190

an integration ID: int_ and 32 lowercase hex digits

Response

The integration

idstring required

an integration ID: int_ and 32 lowercase hex digits

namestring required

The site's everyday name, such as Instacart

descriptionstring required

What the site is, in a sentence

site_urlstring nullable required

The site's https origin; null for an offline integration

visibility'public' | 'private' required
owned_by_meboolean required

Whether it holds a tool you created or own

addedboolean required

Whether your account added it to My integrations

builtboolean required

Whether it holds a tool you or your team created

status'ready' | 'disabled' | 'not_hosted' required

Its MCP: ready with mcp_url, disabled, or not_hosted where this deployment hosts none. Its tools run through the Pomerado MCP and REST in every state.

mcp_urlstring nullable required

Its MCP endpoint while ready; connect with GET /v1/connect

keyless_mcp_urlstring nullable required

Its MCP's URL for use without signing in; null unless the integration is public and ready

mcp_server_namestring nullable required

Its MCP's name in client configs, such as instacart

icon_urlstring nullable required

Its site's icon, a PNG on the API host; null when it has none. Fetch it with the same Authorization: Bearer <API key> header as the API, from a key that can read integrations (tools:read); a key for one integration fetches only its icon. Without credentials it answers 401, and it answers 404 while the site has no captured icon. The URL changes whenever the icon may, so an icon fetched from it can be kept

created_atstring required

a string to be decoded into a Date

updated_atstring required

a string to be decoded into a Date

Example response

{
  "id": "int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190",
  "tools": [
    {
      "id": "tool_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.