Tags

GET /v2/projects/:project_id/tags

List all tags for the given project.

This endpoint is paginated.

Example Request

curl "https://api.phraseapp.com/api/v2/projects/:project_id/tags" \
  -u USERNAME_OR_ACCESS_TOKEN
phraseapp tags list <project_id>

Response

Status: 200
[ { "name": "my-feature", "keys_count": 8, "created_at": "2015-01-28T09:52:53Z", "updated_at": "2015-01-28T09:52:53Z" }, { "name": "my-feature", "keys_count": 8, "created_at": "2015-01-28T09:52:53Z", "updated_at": "2015-01-28T09:52:53Z" } ]

GET /v2/projects/:project_id/tags/:name

Get details and progress information on a single tag for a given project.

Example Request

curl "https://api.phraseapp.com/api/v2/projects/:project_id/tags/:name" \
  -u USERNAME_OR_ACCESS_TOKEN
phraseapp tag show <project_id> <name>

Response

Status: 200
{ "name": "my-feature", "keys_count": 8, "created_at": "2015-01-28T09:52:53Z", "updated_at": "2015-01-28T09:52:53Z", "statistics": [ { "locale": { "id": "abcd1234cdef1234abcd1234cdef1234", "name": "de", "code": "de-DE" }, "statistics": { "keys_total_count": 12, "translations_completed_count": 9, "translations_unverified_count": 11, "keys_untranslated_count": 3 } } ] }

POST /v2/projects/:project_id/tags

Create a new tag.

Parameters

Name Type Description
name string Name of the tag

Example Request

curl "https://api.phraseapp.com/api/v2/projects/:project_id/tags" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -d '{"name":"my-feature"}' \
  -H 'Content-Type: application/json'
phraseapp tag create <project_id> \
--name my-feature

Response

Status: 201
{ "name": "my-feature", "keys_count": 8, "created_at": "2015-01-28T09:52:53Z", "updated_at": "2015-01-28T09:52:53Z", "statistics": [ { "locale": { "id": "abcd1234cdef1234abcd1234cdef1234", "name": "de", "code": "de-DE" }, "statistics": { "keys_total_count": 12, "translations_completed_count": 9, "translations_unverified_count": 11, "keys_untranslated_count": 3 } } ] }

DELETE /v2/projects/:project_id/tags/:name

Delete an existing tag.

Example Request

curl "https://api.phraseapp.com/api/v2/projects/:project_id/tags/:name" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X DELETE
phraseapp tag delete <project_id> <name>

Response

Status: 204