Get project

GET 
/v2/orgs/:org_id/teams/:team_id/projects/:project_id

Retrieves project information, such as a name for an existing project.

Required scope

projects:read

Rate limiting

Level 1

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request

Path Parameters

org_id stringrequired
The ID of the organization from which you want to retrieve the project information.
Example: 3074457345618265000
team_id stringrequired
The ID of the team from which you want to retrieve the project information.
Example: 3074457345619012000
project_id stringrequired
The ID of the project for which you want to retrieve the information.
Example: 3074457345618265000

Responses

200

Project object

application/json

Schema

Schema

id stringrequired

Project ID.

name stringrequired

Name of the project.

type stringrequired

Default value: project

Type of the object returned.

Example (from schema)

{
  "id": "3074457345618265000",
  "name": "Product Guild project",
  "type": "project"
}

400

Malformed request

application/json

Schema

Schema

status number

Default value: 400

HTTP status code.

code string

Default value: invalidParameters

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 400,
  "code": "invalidParameters",
  "message": "string",
  "type": "error"
}

401

Invalid authentication credentials

application/json

Schema

Schema

status number

Default value: 401

HTTP status code.

code string

Default value: tokenNotProvided

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 401,
  "code": "tokenNotProvided",
  "message": "string",
  "type": "error"
}

403

Invalid access

application/json

Schema

Schema

status number

Default value: 403

HTTP status code.

code string

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 403,
  "code": "forbiddenAccess",
  "message": "string",
  "type": "error"
}

404

Not found

application/json

Schema

Schema

status number

Default value: 404

HTTP status code.

code string

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 404,
  "code": "notFound",
  "message": "string",
  "type": "error"
}

429

Too many requests

application/json

Schema

Schema

status number

Default value: 429

HTTP status code.

code string

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 429,
  "code": "tooManyRequests",
  "message": "string",
  "type": "error"
}

Loading...