---
title: "Get one Dictionary"
method: GET
path: "/organizations/{orgId}/environments/{envId}/dictionaries/{hrid}"
tags: ["Dictionaries"]
---

# Get one Dictionary

`GET /organizations/{orgId}/environments/{envId}/dictionaries/{hrid}`

Get an Dictionary using HRID

## Path parameters

- `orgId` string, required
- `envId` string, required
- `hrid` string, required

## Response `200`

Dictionary successfully retrieved

- DictionaryState — Base status properties common to all resources.
  - `hrid` string, required — A unique human readable id identifying this resource
  - `name` string, required — Display name of the dictionary
  - `deployed` boolean, required — If true, a `MANUAL` type dictionary is deployed in the gateway, a `DYNAMIC` type dictionary is started. Changing this value back to false will stop the dictionary or undeploy it.
  - `description` string — Detailed description of the dictionary
  - `type` 'MANUAL' | 'DYNAMIC', required — Type of dictionary. MANUAL is to be updated manually, DYNAMIC is updated and deployed automatically.
  - `manual` ManualDictionarySpec — A manual dictionary with static key/value properties.
    - `properties` object, required — Dictionary data are key/value pairs for `MANUAL` properties
  - `dynamic` DynamicDictionarySpec — A dynamic dictionary populated from an external provider on a schedule.
    - `provider` DictionaryProvider, required — HTTP dictionary provider configuration
      - `type` 'HTTP', required — Type of dictionary provider.
      - `url` string, uri, required — URL of the provider
      - `specification` string, required — Transformation of the returned payload (JOLT Specification)
      - `headers` object[] — HTTP Headers
        - `name` string, required — Header name
        - `value` string, required — Header value
      - `useSystemProxy` boolean
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'CONNECT', required
      - `body` string — Optional request payload
    - `trigger` DictionaryTrigger, required — Renewal configuration for a 'DYNAMIC' dictionary
      - `rate` integer, required
      - `unit` 'MICROSECONDS' | 'MILLISECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS', required
  - `id` string — Resource UUID.
  - `environmentId` string — The environment ID.
  - `organizationId` string — The organization ID.
  - `errors` Errors — When a resource has been created regardless of errors, this field is used to persist the error message encountered during validation
    - `severe` string[] — Severe errors do not pass validation and will block creation/update/delete hence, this field should always be populated during the validation phase and is very unlikely to be persisted client side.
    - `warning` string[] — Warning errors do not block object creation/update/delete, most of the time because the value is ignored or defaulted.

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized
- `404` — Resource not found
- `default` — Default error

---

[API](https://skmtc.net/gravitee-io/apis/gravitee-io-automation-api.md) · [All operations](https://skmtc.net/gravitee-io/apis/gravitee-io-automation-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gravitee-io/gravitee-io-automation-api/revisions/ecefec7d65f9/schema)