Skip to content
GitmoapAPIBeta
Integrateprovider-catalog
GET/providers/{provider_id}

Get one provider's metadata.

get_provider
  • provider_catalog:read
    A token needs the provider_catalog:read scope: Browse the provider catalog and marketplaceGranted by read_api, write_api.Every operation this scope unlocks

The provider's name, description, tier, publisher, latest version, and the credentials a connection to it needs. A private provider is visible only to members of the organization that owns it; anyone else gets 404. Open to any signed-in caller.

Parameters

Path
  • provider_idProviderId (string)Provider slug

Responses

200Provider metadataapplication/json
  • auth_schemaobjectThe JSON Schema a connection's credentials must satisfy, exactly as the provider's gitmoap-provider.yaml declares it.
  • created_atstring
  • descriptionstring
  • idProviderId (string)
  • namestring
  • tierProviderTierplatformverifiedcommunityprivateHow a pipeline provider is distributed and how much it is vouched for.
  • updated_atstring
  • auth_modesarray of ConnectionAuthMode: one of static_credentials | oidc_federationoptionalHow connections to this provider may authenticate (e.g. [static_credentials, oidc_federation]). A connection using any other mode is refused.
  • categoriesarray of Category: one of source-control | build | test | quality | security | release | deploy | infrastructure | notify | otheroptionalThe marketplace categories the provider is listed under, one to three. Empty for a provider with no marketplace listing.
  • featured_rankinteger · int32 or nulloptional0–∞Where gitmoap features the provider: lower numbers are placed higher. Absent when it is not featured.
  • install_countinteger · int64optional0–∞How many organizations have installed the provider. Providers installed by default are not counted.
  • keywordsarray of Keyword (string)optionalSearch keywords from the provider's marketplace listing, up to 10.
  • latest_versionProviderVersion (string) or nulloptionalThe highest published version.
  • publisher_idPublisherId (string · uuid) or nulloptionalThe publisher of the provider. Absent for providers gitmoap builds itself.
  • visibilityProviderVisibilityoptionalWho can see the provider in the catalog: public for platform, verified and community providers; private for a private provider, which only members of its organization see.
200 exampleSynthesized example
{
"auth_schema": {},
"created_at": "2026-10-17T00:33:56Z",
"description": "Renders each region as density contours of its operations.",
"id": "id-720a",
"name": "payments-api",
"tier": "platform",
"updated_at": "2026-10-16T00:48:19Z",
"auth_modes": [
"static_credentials"
],
"categories": [
"source-control"
],
"featured_rank": 13,
"install_count": 6,
"keywords": [
"keywords-b726",
"keywords-d77b"
],
"latest_version": "latest-version-52f2",
"publisher_id": "8dc32b06-67d1-427c-88c8-fb54c607f1df",
"visibility": {
"kind": "public"
}
}
400application/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-6b60",
"message": "Inline scalar newtypes but keep their brand"
}
}
401application/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-d6a9",
"message": "Pin a page's payload to the build that rendered it"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-85fa",
"message": "Pin a page's payload to the build that rendered it"
}
}
404application/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-e945",
"message": "Inline scalar newtypes but keep their brand"
}
}

CLI

gitmoap provider-catalog get-provider

  • --provider-ididProvider slug

Used in these guides