{
  "opencollection": "1.0.0",
  "info": {
    "name": "Phrase Strings API Reference Accounts Keys API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Keys",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "per_page",
                "value": "25",
                "type": "query",
                "description": "Limit on the number of objects to be returned, between 1 and 100. 25 by default"
              },
              {
                "name": "branch",
                "value": "my-feature-branch",
                "type": "query",
                "description": "specify the branch to use"
              },
              {
                "name": "sort",
                "value": "updated_at",
                "type": "query",
                "description": "Sort by field. Can be one of: name, created_at, updated_at."
              },
              {
                "name": "order",
                "value": "desc",
                "type": "query",
                "description": "Order direction. Can be one of: asc, desc."
              },
              {
                "name": "q",
                "value": "mykey* translated:true",
                "type": "query",
                "description": "Specify a query to do broad search for keys by name (including wildcards).\n\nThe following qualifiers are also supported in the search term:\n\n- `ids:key_id,...` for queries on a comma-separated list of ids\n- `name:key_name` for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes\n- `tags:tag_name` to filter for keys with certain tags\n- `translated:{true|false}` for translation status (also requires `locale_id` to be specified)\n- `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n- `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads\n\n**Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored.\n\nFind more examples [here](/en/api/strings/usage-examples).\n"
              },
              {
                "name": "locale_id",
                "value": "abcd1234abcd1234abcd1234abcd1234",
                "type": "query",
                "description": "Locale used to determine the translation state of a key when filtering for untranslated or translated keys."
              }
            ]
          },
          "docs": "List all keys for the given project. Alternatively you can POST requests to /search."
        },
        {
          "info": {
            "name": "Create a key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new key."
        },
        {
          "info": {
            "name": "Delete collection of keys",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              },
              {
                "name": "branch",
                "value": "my-feature-branch",
                "type": "query",
                "description": "specify the branch to use"
              },
              {
                "name": "q",
                "value": "mykey* translated:true",
                "type": "query",
                "description": "Specify a query to do broad search for keys by name (including wildcards).\n\nThe following qualifiers are also supported in the search term:\n\n- `ids:key_id,...` for queries on a comma-separated list of ids\n- `name:key_name` for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes\n- `tags:tag_name` to filter for keys with certain tags\n- `translated:{true|false}` for translation status (also requires `locale_id` to be specified)\n- `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n- `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads\n\n**Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored.\n\nFind more examples [here](/en/api/strings/usage-examples).\n"
              },
              {
                "name": "locale_id",
                "value": "abcd1234abcd1234abcd1234abcd1234",
                "type": "query",
                "description": "Locale used to determine the translation state of a key when filtering for untranslated or translated keys."
              }
            ]
          },
          "docs": "Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise."
        },
        {
          "info": {
            "name": "Search keys",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys/search",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "per_page",
                "value": "25",
                "type": "query",
                "description": "Limit on the number of objects to be returned, between 1 and 100. 25 by default"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search keys for the given project matching query."
        },
        {
          "info": {
            "name": "Get a single key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys/:id",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID"
              },
              {
                "name": "branch",
                "value": "my-feature-branch",
                "type": "query",
                "description": "specify the branch to use"
              }
            ]
          },
          "docs": "Get details on a single key for a given project."
        },
        {
          "info": {
            "name": "Update a key",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys/:id",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing key."
        },
        {
          "info": {
            "name": "Delete a key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys/:id",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID"
              },
              {
                "name": "branch",
                "value": "my-feature-branch",
                "type": "query",
                "description": "specify the branch to use"
              }
            ]
          },
          "docs": "Delete an existing key."
        },
        {
          "info": {
            "name": "Add tags to collection of keys",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys/tag",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Tags all keys matching query. Same constraints as list."
        },
        {
          "info": {
            "name": "Remove tags from collection of keys",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys/untag",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Removes specified tags from keys matching query."
        },
        {
          "info": {
            "name": "Exclude a locale on a collection of keys",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys/exclude",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Exclude a locale on keys matching query. Same constraints as list."
        },
        {
          "info": {
            "name": "Include a locale on a collection of keys",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.phrase.com/v2/projects/:project_id/keys/include",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Include a locale on keys matching query. Same constraints as list."
        }
      ]
    }
  ],
  "bundled": true
}