Sign in
Projects

List Projects

Changed on
get/projects

Request

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

Query parameters

searchstring

Search string to find projects

idsstring[]

The ID of a project to search for

namesstring[]

The name of the project

ownerstring[]

Owner of the project

publicboolean

Boolean check for public/private projects

permissionsstring[]

Filter by permission on given resource

sort_by'created_at' | 'updated_at' | 'name'

An enumeration.

Key to sort the list by

sort_order'ascending' | 'descending'

An enumeration.

The order to sort the list

pageinteger

Page number starting from 1

per-pageinteger

Number of items per page

Response

Retrieved

pageinteger required

The current page the pagination request is on

per_pageinteger required

The number of pages per pagination request

page_countinteger required

The total number of pages

total_countinteger required

The total number of resources matching the list request

next_pageinteger

The next page, if this on is not the last

Example response

{
  "resources": [
    {
      "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

      for the query request parameter owner, default value was added

    • 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

      deleted the query request parameter id

    • warning

      deleted the query request parameter name

    • warning

      deleted the query request parameter permission

    • 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 the new optional query request parameter ids

    • info

      added the new optional query request parameter names

    • info

      added the new optional query request parameter permissions

    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_order

    • info

      for the query request parameter search, the type was generalized from array to string

    • 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