List projects

cURL

curl "https://api.phrase.com/v2/projects" \
  -u USERNAME_OR_ACCESS_TOKEN

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.phrase.com/v2/projects', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

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

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": "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"
  }
]

GET

projects

cURL

curl "https://api.phrase.com/v2/projects" \
  -u USERNAME_OR_ACCESS_TOKEN

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.phrase.com/v2/projects', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

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

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": "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"
  }
]

Authorizations

Authorization

string

header

required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP

string

Two-Factor-Authentication token (optional)

Query Parameters

page

integer

Page number

per_page

integer

Limit on the number of objects to be returned, between 1 and 100. 25 by default

account_id

string

Filter by Account ID

sort_by

enum<string>

Sort projects. Valid values are name_asc, name_desc, updated_at_asc, updated_at_desc, space_asc, and space_desc. The trailing direction segment is optional; if omitted or invalid, projects are sorted ascending. Any other value is ignored and the default ordering is returned.

Available options:

name_asc,

name_desc,

updated_at_asc,

updated_at_desc,

space_asc,

space_desc

filters

enum<string>[]

Filter projects. The only supported value is favorites, which restricts the results to projects the current user has starred.

Available options:

favorites

string

Search query. The only supported syntax is name:<text> — for example name:android returns projects whose name matches android (case-insensitive substring). Any value that does not match the name: prefix is ignored.

Response

string

name

string

slug

string

main_format

string

project_image_url

string

media

string

account

account · object

Show child attributes

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

Show child attributes

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

Show child attributes

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "username": "johndoe",
  "name": "John Doe",
  "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}

created_at

string<date-time>

updated_at

string<date-time>

Get a single pre-translation job Create a project

⌘I

Guides

API Documentation

Authorizations

Headers

Query Parameters

Response