Skip to main content
GET
/
projects
/
{id}
cURL
curl "https://api.phrase.com/v2/projects/:id" \
  -u USERNAME_OR_ACCESS_TOKEN
phrase projects show \
--id <id> \
--access_token <token>
import requests

url = "https://api.phrase.com/v2/projects/{id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.phrase.com/v2/projects/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.phrase.com/v2/projects/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.phrase.com/v2/projects/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.phrase.com/v2/projects/{id}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.phrase.com/v2/projects/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "slug": "my-android-project",
  "main_format": "xml",
  "project_image_url": "http://assets.example.com/project.png",
  "account": "account",
  "space": "space",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "shares_translation_memory": true,
  "machine_translation_enabled": true,
  "zero_plural_form_enabled": true,
  "enable_all_data_type_translation_keys_for_translators": false,
  "enable_icu_message_format": false,
  "enable_branching": false,
  "protect_master_branch": false,
  "autotranslate_enabled": false,
  "autotranslate_check_new_translation_keys": false,
  "autotranslate_check_new_uploads": false,
  "autotranslate_check_new_locales": false,
  "autotranslate_mark_as_unverified": false,
  "autotranslate_use_machine_translation": false,
  "autotranslate_use_translation_memory": true,
  "autotranslate_overwrite_unverified_translations": false,
  "autocomplete_job_enabled": false,
  "default_encoding": "UTF-8",
  "cldr_version": "legacy",
  "job_locking_enabled": false,
  "placeholder_styles": [
    "angular",
    "iOS"
  ]
}

Authorizations

Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

id
string
required

ID

Response

OK

id
string
name
string
slug
string
main_format
string
project_image_url
string
media
string
account
account · object
Example:
{
"id": "abcd1234",
"name": "Company Account",
"slug": "company_account",
"company": "My Awesome Company",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"company_logo_url": "http://assets.example.com/company_logo.png"
}
space
space · object
Example:
{
"id": "2e7574e8f2372906a03110c2a7cfe671",
"name": "My first space",
"created_at": "2020-02-25T12:17:25Z",
"updated_at": "2020-03-13T14:46:57Z",
"projects_count": 2
}
point_of_contact
user_preview · object
Example:
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"username": "johndoe",
"name": "John Doe",
"gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}
created_at
string<date-time>
updated_at
string<date-time>
shares_translation_memory
boolean
machine_translation_enabled
boolean
Example:

true

zero_plural_form_enabled
boolean
Example:

true

enable_all_data_type_translation_keys_for_translators
boolean
Example:

false

enable_icu_message_format
boolean
Example:

false

enable_branching
boolean
Example:

false

protect_master_branch
boolean
Example:

false

autotranslate_enabled
boolean
Example:

false

autotranslate_check_new_translation_keys
boolean
Example:

false

autotranslate_check_new_uploads
boolean
Example:

false

autotranslate_check_new_locales
boolean
Example:

false

autotranslate_mark_as_unverified
boolean
Example:

false

autotranslate_use_machine_translation
boolean
Example:

false

autotranslate_use_translation_memory
boolean
Example:

true

autotranslate_overwrite_unverified_translations
boolean
Example:

false

autocomplete_job_enabled
boolean
Example:

false

default_encoding
string
Example:

"UTF-8"

cldr_version
string
Example:

"legacy"

job_locking_enabled
boolean
Example:

false

placeholder_styles
string[]
Example:
["angular", "iOS"]
branch
branch · object
Example:
{
"name": "new-branch",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"merged_at": "2015-01-28T09:52:53Z",
"merged_by": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"username": "joe.doe",
"name": "Joe Doe"
},
"created_by": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"username": "joe.doe",
"name": "Joe Doe"
},
"state": "success",
"child_branches": ["feature_2", "feature_3"]
}