{
  "opencollection": "1.0.0",
  "info": {
    "name": "Phrase Strings API Reference Accounts Jobs API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs",
            "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": "Branch to use"
              },
              {
                "name": "owned_by",
                "value": "abcd1234cdef1234abcd1234cdef1234",
                "type": "query",
                "description": "filter by user owning job"
              },
              {
                "name": "assigned_to",
                "value": "abcd1234cdef1234abcd1234cdef1234",
                "type": "query",
                "description": "filter by user assigned to job"
              },
              {
                "name": "state",
                "value": "completed",
                "type": "query",
                "description": "filter by state of job; valid states are: `draft`, `in_progress`, `completed`"
              },
              {
                "name": "updated_since",
                "value": "2013-02-21T00:00:00Z",
                "type": "query",
                "description": "filter by jobs updated since given date"
              }
            ]
          },
          "docs": "List all jobs for the given project."
        },
        {
          "info": {
            "name": "Create a job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new job."
        },
        {
          "info": {
            "name": "List account jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.phrase.com/v2/accounts/:account_id/jobs",
            "headers": [
              {
                "name": "X-PhraseApp-OTP",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "Account 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": "owned_by",
                "value": "abcd1234cdef1234abcd1234cdef1234",
                "type": "query",
                "description": "filter by user owning job"
              },
              {
                "name": "assigned_to",
                "value": "abcd1234cdef1234abcd1234cdef1234",
                "type": "query",
                "description": "filter by user assigned to job"
              },
              {
                "name": "state",
                "value": "completed",
                "type": "query",
                "description": "filter by state of job; valid states are: `draft`, `in_progress`, `completed`"
              },
              {
                "name": "updated_since",
                "value": "2013-02-21T00:00:00Z",
                "type": "query",
                "description": "filter by jobs updated since given date"
              }
            ]
          },
          "docs": "List all jobs for the given account."
        },
        {
          "info": {
            "name": "Get a single job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/: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": "Branch to use"
              },
              {
                "name": "include_annotations",
                "value": "",
                "type": "query",
                "description": "Include job-locale annotations in the response"
              },
              {
                "name": "omit_translation_keys",
                "value": "",
                "type": "query",
                "description": "Omit translation keys in the response to reduce payload size for bigger jobs"
              }
            ]
          },
          "docs": "Get details on a single job for a given project."
        },
        {
          "info": {
            "name": "Update a job",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/: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 job."
        },
        {
          "info": {
            "name": "Delete a job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/: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 job."
        },
        {
          "info": {
            "name": "Start a job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:id/start",
            "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": "Starts an existing job in state draft."
        },
        {
          "info": {
            "name": "Complete a job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:id/complete",
            "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": "Mark a job as completed."
        },
        {
          "info": {
            "name": "Reopen a job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:id/reopen",
            "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": "Mark a job as uncompleted."
        },
        {
          "info": {
            "name": "Lock a job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:id/lock",
            "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": "If you are the job owner, you may lock a job using this API request."
        },
        {
          "info": {
            "name": "Unlock a job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:id/unlock",
            "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": "If you are the job owner, you may unlock a locked job using this API request."
        },
        {
          "info": {
            "name": "Add keys to job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:id/keys",
            "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": "Add multiple keys to a existing job."
        },
        {
          "info": {
            "name": "Remove keys from job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:id/keys",
            "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": "Remove multiple keys from existing job."
        }
      ]
    }
  ],
  "bundled": true
}