--- title: "Gets a list of all catalogs" method: GET path: "/catalogs" tags: ["config"] --- # Gets a list of all catalogs `GET /catalogs` Lists all catalogs that your account has access to. To get access to a catalog, your administrator must associate this catalog in your HERE platform account. By default, the list provides summary data for each catalog such as the title, the configuration URL, and the resource type. Note: If you have access to tens of thousands of catalogs or more, and it takes the server more than 50 seconds to generate the result, a partial response may be returned. Our testing indicates that a user with permission to access 50000 catalogs takes roughly 50 seconds to generate the result. ## Query parameters - `verbose` boolean - `q` string - `organisation` string - `organisationType` string[] - `layerType` string[] - `region` string[] - `schemaHrn` string - `resourceType` 'catalog' | 'layer' - `coverage` string[] - `access` string[] - `marketplaceReady` boolean - `limit` integer - `sortBy` 'name' | 'created' - `sortOrder` 'asc' | 'desc' - `linkable` boolean - `billingTag` string ## Response `200` OK - union - CatalogsListResult — Contains a list of catalogs the user has access to. - `verbose` boolean - `results` CatalogsList — List of the catalog configurations. - `items` Catalog[] - `id` string, required — The ID to use when referring to this catalog programmatically. Catalog IDs must be unique across all catalogs in the Open Location Platform. Do not put private information in the catalog ID. The catalog ID forms a portion of the catalog's HERE Resource Name (HRN), and HRNs are visible to other users. Only lowercase alphanumeric characters (a-z), digits (0-9) and dash (-) are allowed in a catalog ID and the first and the last character must be a-z or 0-9. - `hrn` string, required — The HERE Resource Name (HRN) of the catalog - `name` string, required — The short name for the catalog - `summary` string, required — A one-sentence summary of the catalog. You can see this summary when you browse a list of catalogs on the platform portal. - `description` string, required — A detailed description of the catalog and what it contains. This information appears on the 'Overview' tab when you open a catalog in the platform portal. - `coverage` Coverage — The geographic area that this layer covers - `adminAreas` string[] — A list of ISO 3166 two-letter codes for countries and regions optionally followed by up to three characters codes for subdivisions, such as 'DE', 'PL', or 'CN-HK'. - `owner` Owner - `creator` Creator - `id` string — The unique ID of the user or application that initially created the catalog - `organisation` Organisation - `id` string — The ID of the customer organisation relating to this catalog - `tags` string[], required — Some keywords that help to find the catalog when searching in the platform portal - `billingTags` string[] — Aggregated list of all layers` billing tags. Note that this element is read-only and does not exist in `CreateCatalog`. If posted during catalog creation, the value will be ignored. - `created` string, required — Timestamp, in ISO 8601 format, when the catalog was initially created. - `replication` Replication, required - `regions` ReplicationRegion[] — A list of the catalog's replication regions and each region's role. For multi-region replication, catalogs list should contain multiple items where at least one should be with a `primary` role. For single-region replication, catalogs should define `primary` region. Both `eu-ireland` and `us-oregon` are allowed as primary region. - `id` 'eu-ireland' | 'us-oregon' | 'ap-seoul', required — The ID of the region - `role` 'primary' | 'secondary' — Indicates whether the region is a primary or failover region. You can specify one of the following: `primary` - The region is used by default for reading and writing. `secondary` - The region used as a failover region. - `automaticVersionDeletion` union - object - `numberOfVersionsToKeep` integer, required — Specifies how many versions to keep. To optimise storage costs, you can specify how many latest versions to keep. The minimum number of versions to keep is 1. The maximum number of versions to keep is 50,000. - `ttlDays` integer — Specifies the number of days to keep versions, counting from their creation time. The minimum ttlDays value is 3 days. - object - `numberOfVersionsToKeep` integer — Specifies how many versions to keep. To optimise storage costs, you can specify how many latest versions to keep. The minimum number of versions to keep is 1. The maximum number of versions to keep is 50,000. - `ttlDays` integer, required — Specifies the number of days to keep versions, counting from their creation time. The minimum ttlDays value is 3 days. - `layers` union[], required — The layers in the catalog. - union - VersionedLayer — Describes the catalog versioned layer properties. - … - VolatileLayer — Describes the catalog volatile layer properties. - … - StreamLayer — Describes the catalog stream layer properties. - … - IndexLayer — Describes the catalog index layer properties. - … - InteractiveMapsLayer — Describes the catalog interactive maps layer properties. - … - ObjectstoreLayer — Describes the catalog objectstore layer properties. - … - `areaScheme` string — This field is deprecated on the catalog level. Use **/catalogs/{catalogHrn}/dataSubsets** to set areaScheme in the dataSubset instead. HERE Resource Name (HRN) of the Area Scheme used in the data subset. After deprecation setting areaScheme on the catalog level takes no effect. It will simply be ignored. - `subsetRestrictions` boolean — This field is deprecated on the catalog level. Use subsetRestrictions on the layer level only. Indicates if the subsetRestrictions for a layer is enabled or not. Supported only for layers with heretile partitioning. After deprecation setting subsetRestrictions on the catalog level takes no effect. It will simply be ignored. - `version` integer, required — The version of the catalog configuration. Every change in this number indicates a change in the catalog configuration. It is incremented every time you make changes, such as change catalog parameters or add layers. Note that this is not a metadata/data version as configuration and metadata versions are independent of each other and indicate different kind of changes. - `notifications` Notifications — When set to true, a notification is written to the notification stream each time the version of the catalog changes. This field is optional, but you can update the value to modify notifications. Additionally, this field is not removable, and a null value is not allowed. - `enabled` boolean - `marketplaceReady` boolean — Indicates whether the catalog is ready to be listed in the Marketplace. If the value is `true`, the catalog is ready to be listed in the Marketplace. - `next` string — The link to the next page of catalogs result list - `previous` string — The link to the previous page of catalogs result list - CatalogsSummaryListResult — Contains a list of catalog summaries the user has access to. - `verbose` boolean - `results` CatalogsSummaryList — List of the catalog summaries - `items` CatalogSummary[] - `href` string — The link to the catalog details - `hrn` string — The HERE Resource Name (HRN) for the catalog - `title` string — The name of the catalog as specified in the "name" property when the catalog was created - `type` string — The type of the href. All hrefs are currently set to urn:olp-types:catalog. - `next` string — The link to the next page of catalogs result list - `previous` string — The link to the previous page of catalogs result list ## Other responses - `401` — Unauthorized - `403` — Forbidden --- [API](https://skmtc.dev/here/apis/query-api-v1.md) · [All operations](https://skmtc.dev/here/apis/query-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/here/query-api-v1/revisions/30e5d2645407/schema)