Sign in
latestOpenAPI 3.1.02026-08-10150311431.9 KB

c1f3c6d96b31

Accounts

List Accounts on the Pollination platform

List accounts

get/accounts

Query parameters

searchstring

Search string to find accounts

Search string to find accounts

typestring

Whether the account is for a user or an org

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

Page number starting from 1

per-pageinteger

Number of items per page

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

next_pageinteger

The next page, if this on is not the last

page_countinteger required

The total number of pages

total_countinteger required

The total number of resources matching the list request

Example response

{
  "resources": [
    {
      "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
      "account_type": "user",
      "name": "ladybugbot",
      "display_name": "Ladybug Bot",
      "description": "Beep Boop!"
    }
  ]
}