Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
app

Return a particular app by name

get/v1/app/name/{appName}

Path parameters

appNamestring required

App name

Response

successful operation

idstring required

globally unique id

orgIdstring required

organization id

namestring required

short unique name

redirectUrisstring[]

list of acceptable Oauth2 redirect URIs, if Oauth2 is supported for this app

oauthClientIdsstring[]

OAuth client identities allowed to connect as this agent over MCP. Each entry is either a full Client ID Metadata Document (CIMD) URL (matched exactly, e.g. Claude Code's fixed URL) or a bare host (matched against the client_id's host, e.g. chatgpt.com, for clients whose CIMD URL varies per server).

mcpInstructionsstring

Connection instructions shown on the agent's MCP tab (e.g. how to add this MCP server to a client like Claude Code). The literal token {{mcpUrl}} is replaced with the org-specific MCP server URL when displayed.

allowedIpsstring[]

allowlist of IPs or IP ranges that are allowed to make API calls on behalf of this app

titlestring required

human-readable name of app

summarystring required

short summary of app

descriptionstring

full description of app, in Markdown

setupInstructionsstring

setup instructions, in Markdown

cronOrderinteger

execution order of the cron (lower numbers execute earlier)

cronSchedule'DAILY' | 'WEEKLY'

cron schedule

cronDayOfWeek'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'

Day of week if cronSchedule is WEEKLY

imagePathstring

path to avatar profile image, should be approximately square dimensions and show logo

wordmarkImagePathstring

path to larger profile logo image containing brand wordmark, does not need to be square dimensions

poweredByImagePathstring

path to powered by image, should be approximately square dimensions and show logo

status'GLOBAL' | 'ACTIVE' | 'INACTIVE' | 'DEVELOPMENT' required

current status of app

minAccess'NONE' | 'PREBOARDING' | 'VIEW' | 'LIMITED' | 'MEMBER_LIMITED_COMP' | 'MEMBER' | 'CUSTOM' | 'TECH_OWNER' | 'TIMEOFF' | 'CONTACT' | 'COMP_CASH' | 'COMP_EQUITY' | 'COMP_ALL' | 'RECRUIT_SENSITIVE' | 'RECRUIT_PRIMARY' | 'SENSITIVE_LIMITED_COMP' | 'SENSITIVE' | 'PRIMARY' | 'PEOPLE_OPS_ADMIN' | 'PEOPLE_OPS_ADMIN_NO_COMP_DATA' | 'PEOPLE_OPS_ADMIN_NO_SENSITIVE_DATA' | 'OWNER' required

minimum access level requested by app

roleIdstring

roleId requested by app

eventNotifyUrlstring uri

URL that should be notified on events

payloadobject

custom payload to send in lieu of regular payload

eventsstring[]

set of events to notify on

type'AGENT' | 'APP' | 'BUNDLE' | 'INTERNAL'

APP, BUNDLE, or INTERNAL

scopesstring[]

access scopes that the app is requesting

tagsstring[]

tags/categories the app belongs to

requiredFeaturesstring[]

The product features that are required in order to install the app or bundle

internalOptionsobject

internal (ChartHop controlled) options

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp