Skip to Content
kosemdocs
ReferenceAPIProjects

Get project

Gets a project.

GET
/v1/projects/{project}

Gets a project.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

project*string

The project's ID.

Match^prj_[0-7][0-9a-hjkmnp-tv-z]{25}$

Response Body

OK

application/json
  1. response
createTime*string

When the project was created.

Formatdate-time
deleteTime?string

When its deletion was requested; absent while it is active.

Formatdate-time
displayName*string

Name shown in user interfaces.

name*string

Resource name, projects/{project_id}. The ID is generated by the server and never changes.

parent*string

The organization the project belongs to, organizations/{organization_id}.

purgeTime?string

When kosem purges it, with everything in it, 30 days after its deletion was requested, unless it is undeleted first; absent while it is active.

Formatdate-time
slug*string

Globally unique, human-readable alias. It never changes, so that links to the project keep working.

state*string

Lifecycle state. Nothing in a project whose deletion was requested works but reading and restoring it, and it is purged at its purgeTime unless it is undeleted first.

Value in"ACTIVE""DELETE_REQUESTED"
updateTime*string

When the project was last updated.

Formatdate-time
Example Request
curl -X GET 'https://api.kosem.ai/v1/projects/string'
Example Response
{
  "createTime": "2019-08-24T14:15:22Z",
  "deleteTime": "2019-08-24T14:15:22Z",
  "displayName": "string",
  "name": "string",
  "parent": "string",
  "purgeTime": "2019-08-24T14:15:22Z",
  "slug": "string",
  "state": "ACTIVE",
  "updateTime": "2019-08-24T14:15:22Z"
}