Accounts

List Accounts on the Pollination platform

Changed on

List accounts

get/accounts

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 accounts

typestring

Whether the account is for a user or an org

role'owner' | 'member'

An enumeration.

The role the user has in relation to this account

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": "0ad77f99-8043-46e4-8220-7221487c3ee5",
      "account_type": "user",
      "name": "ladybugbot",
      "display_name": "Ladybug Bot",
      "description": "Beep Boop!"
    }
  ]
}

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

      the endpoint scheme security APIKeyAuth was added to the API

    • info

      the endpoint scheme security JWTAuth was added to the API

    • info

      added the new optional query request parameter role