Skip to content

API V1 · Projects

Get project details

GET
/v1/{workspaceUrl}/projects/{projectUrl}
curl --request GET \
--url https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL \
--header 'Authorization: Bearer YOUR_API_KEY'

Retrieves detailed information for a specific project, including its title, description, configured locales, owner, and HATEOAS links to related resources such as the project’s resource files.

workspaceUrl
required
string

WorkspaceUrl

projectUrl
required
string

ProjectUrl

Successfully returns the project details.

Media typeapplication/json

Detailed information about a localization project including its locales, owner, and HATEOAS links.

object
title

The title of the project.

string
owner_email

Email address of the project’s owner.

string
description

Project description.

string
project_locales

The list of locale codes configured for the project.

Array<string>
created_at

Timestamp when the project was created.

string format: date-time
updated_at

Timestamp when the project was last updated.

string format: date-time
links

HATEOAS links for navigating to related resources (e.g. project resources, status).

Array<object>
object
href
string
hreflang
string
title
string
type
string
deprecation
string
profile
string
name
string
templated
boolean

Examples

ExampleprojectDetails

A project with three locales

ProjectDetails

{
"title": "Frontend",
"description": null,
"links": [
{
"rel": "self",
"href": "https://api.lingohub.com/v1/lingohub-demo/projects/gl-ios"
},
{
"rel": "resources",
"href": "https://api.lingohub.com/v1/lingohub-demo/projects/gl-ios/resources"
}
],
"owner_email": "demo@lingohub.com",
"project_locales": [
"en",
"de",
"zh-Hant"
],
"created_at": "2024-05-13T13:49:38.000+00:00",
"updated_at": "2024-07-01T13:25:21.000+00:00"
}

Unauthorized: Authentication credentials are missing or invalid.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

{
"url": "example",
"message": "example",
"text": "example"
}

Forbidden: The authenticated user does not have permission to view this project.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

{
"url": "example",
"message": "example",
"text": "example"
}

Not Found: The specified workspace or project does not exist.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

{
"url": "example",
"message": "example",
"text": "example"
}