Skip to main content
GET
Get a catalogue

Authorizations

Authorization
string
header
required

Path Parameters

catalogue_id
integer
required

UID of a catalogue

Example:

1

Response

200 - application/json

OK

ID
integer

UID of a catalogue

Example:

1

Name
string

Name this catalogue

Example:

"Private Catalogue"

CreatedAt
string

Timestamp of when this catalogue was created

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"

UpdatedAt
string

Timestamp of when this catalogue was updated the last time

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"

OrgCatalogues
object[]
Plans
string[]

Plans that are included into this catalogue

Name of a plan

Products
string[]

Products that are included into this catalogue

Name of a product

VisibilityStatus
enum<string>

Visibility of this catalogue. Could be either Private or Public. The Private status means this catalogue is visible only to a limited audience while Public catalogue is available to all developers

Available options:
Private,
Public
Example:

"Private"