v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Style guides

Get a single style guide

Get details on a single style guide.

get/projects/{project_id}/styleguides/{id}

Path parameters

project_idstring required

Project ID

idstring required

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

idstring

titlestring

created_atstring date-time

updated_atstring date-time

public_urlstring

audiencestring

target_audiencestring

grammatical_personstring

vocabulary_typestring

businessstring

company_brandingstring

formattingstring

glossary_termsstring

grammar_consistencystring

literal_translationstring

overall_tonestring

samplesstring

Example response

{
  "public_url": "https://phrase.com/styleguide/my-project/26f065cf597be340",
  "audience": "customer-facing",
  "target_audience": "teenager",
  "grammatical_person": "first_person_singular",
  "vocabulary_type": "technical",
  "business": "We are a travel site that helps customers find the best hotels and flights.",
  "company_branding": "ACME Inc. should never be translated.",
  "formatting": "Never use capital letters",
  "glossary_terms": "Apartment, cabin, loft",
  "grammar_consistency": "",
  "literal_translation": "Neutral",
  "overall_tone": "Tone should be fun and light",
  "samples": "http://www.myexample.com/my/document/path/to/samples.pdf"
}