Skip to main content
GET
Get Catalog Connect Form

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

catalog_item_id
string<uuid>
required
workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Response

Successful Response

How a catalog API is connected: by signing in, or by entering its keys.

auth
enum<string>
required
Available options:
oauth,
api_key
catalog_item_id
string<uuid>
required
name
string
required
description
string | null
fields
CatalogKeyFieldResponse · object[]