Projects

Get a project

Changed on
get/projects/{owner}/{name}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header x-pollination-token

Path parameters

ownerstring required
namestring required

Response

Retrieved

namestring required

The name of the project. Must be unique to a given owner

idstring required

The project ID

slugstring required

The project name in slug format

descriptionstring

A description of the project

publicboolean

Whether or not a project is publicly viewable

Example response

{
  "name": "Project Falcon",
  "id": "50bb7fe0-8f19-499e-972e-1ebec8af2c71",
  "owner": {
    "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
    "account_type": "user",
    "name": "ladybugbot",
    "display_name": "Ladybug Bot",
    "description": "Beep Boop!"
  },
  "permissions": {
    "read": true
  },
  "slug": "project-falcon",
  "description": "I always wanted to have a project called project Falcon"
}

Changes

  • f1a5b919697eRevision changes
    • breaking

      response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422

  • 384475d60269Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status