Skip to main content
GET
/
api
/
v1
/
styleguides
/
{id}
Get a Style Guide
curl --request GET \
  --url https://eu.phrase.com/styleguide/api/v1/styleguides/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://eu.phrase.com/styleguide/api/v1/styleguides/{id}"

headers = {"Authorization": "Bearer <token>"}

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

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

fetch('https://eu.phrase.com/styleguide/api/v1/styleguides/{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://eu.phrase.com/styleguide/api/v1/styleguides/{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: Bearer <token>"
],
]);

$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://eu.phrase.com/styleguide/api/v1/styleguides/{id}"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://eu.phrase.com/styleguide/api/v1/styleguides/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://eu.phrase.com/styleguide/api/v1/styleguides/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "018e1234-5678-7890-abcd-ef1234567890",
  "name": "English Style Guide",
  "description": "Style guide for English content",
  "language": {
    "bcpCode": "en-GB",
    "description": "English (United Kingdom)",
    "language": "cs",
    "region": "gb",
    "script": "LATN"
  },
  "isDefault": false,
  "createdBy": {
    "id": "0015oCjtouINgRCDIvQtjo",
    "username": "john.doe",
    "fullName": "John Doe",
    "email": "john.doe@example.com",
    "avatarUrl": "https://example.com/avatars/john-doe.png"
  },
  "lastModifiedBy": {
    "id": "0015oCjtouINgRCDIvQtjo",
    "username": "john.doe",
    "fullName": "John Doe",
    "email": "john.doe@example.com",
    "avatarUrl": "https://example.com/avatars/john-doe.png"
  },
  "contentGroup": {
    "id": "my-content-group"
  },
  "versions": [
    {
      "id": "018e1234-5678-7890-abcd-ef1234567890",
      "versionNumber": 1,
      "name": "English Style Guide v1",
      "description": "Initial version of the style guide",
      "changeNotes": "Updated grammar rules and added new terminology",
      "fileName": "StyleGuide.md",
      "fileSizeBytes": 1024,
      "fileType": "text/markdown",
      "createdAt": "2024-01-15T10:30:00Z",
      "lastModifiedAt": "2024-01-15T10:30:00Z",
      "lastModifiedBy": {
        "id": "0015oCjtouINgRCDIvQtjo",
        "username": "john.doe",
        "fullName": "John Doe",
        "email": "john.doe@example.com",
        "avatarUrl": "https://example.com/avatars/john-doe.png"
      },
      "contentGroup": {
        "id": "my-content-group"
      }
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "lastModifiedAt": "2024-01-15T10:30:00Z",
  "extractedRulesCount": 25
}
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}

Authorizations

Authorization
string
header
required

JWT from IDM (Authorization: Bearer )

Path Parameters

id
string<uuid>
required

Style Guide ID

Query Parameters

includeVersions
boolean
default:false

Whether to include versions in the response

Response

Style Guide retrieved successfully

Style Guide information

id
string<uuid>

Unique identifier of the Style Guide

Example:

"018e1234-5678-7890-abcd-ef1234567890"

name
string

Name of the Style Guide (latest version)

Maximum string length: 50
Example:

"English Style Guide"

description
string

Description of the Style Guide (latest version)

Maximum string length: 250
Example:

"Style guide for English content"

language
object

Language details

isDefault
boolean

Whether this is the default Style Guide

Example:

false

createdBy
object

User who created the Style Guide

lastModifiedBy
object

User who last modified the Style Guide

contentGroup
object

Content group associated with this Style Guide

versions
object[]

List of all versions of this Style Guide. Only present when includeVersions=true.

createdAt
string<date-time>

Timestamp when the Style Guide was created

Example:

"2024-01-15T10:30:00Z"

lastModifiedAt
string<date-time>

Timestamp when the Style Guide was last modified

Example:

"2024-01-15T10:30:00Z"

extractedRulesCount
integer<int32>

Number of rules extracted and linked to the content group during this create/update operation. Only present for create/update responses when a content group is set; absent otherwise.

Example:

25