Sign in
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

typestring

A base class to use when there is no baseclass available to fall on.

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

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

  • be42c3cf5190Revision changes
    • breaking

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

    • warning

      for the query request parameter role, the type of property allOf[RoleEnum -> subschema #1: RoleEnum]/ changed from no type to string

    • info

      added the enum value member to the property allOf[RoleEnum -> subschema #1: RoleEnum]/ of the query request parameter role

    • info

      added the enum value owner to the property allOf[RoleEnum -> subschema #1: RoleEnum]/ of the query request parameter role

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      added the optional property to the response with the status