Sign in
Orgs

List Orgs

Changed on

search for orgs using query parameters

get/orgs

Request

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

Query parameters

searchstring[]

You know, for search

namestring[]

The account name

memberstring[]

The username of a user

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": [
    {
      "id": "1eb8e60d-771d-4a30-8078-fe553eb2f0bc",
      "owner": {
        "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
        "account_type": "user",
        "name": "ladybugbot",
        "display_name": "Ladybug Bot",
        "description": "Beep Boop!"
      },
      "account_name": "ladybug-tools",
      "name": "Ladybug Tools",
      "picture_url": "https://avatars1.githubusercontent.com/u/38131342",
      "contact_email": "info@ladybug.tools",
      "description": "Making environmental design knowledge and tools freely accessible to every person, project and design process",
      "member_count": 10,
      "team_count": 3
    }
  ]
}

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
    • info

      added the optional property // to the response with the status