List Customer Portals

Request

This endpoint lists all portals for the customer. It returns a PortalListResponse object containing a list of Portal objects.

Security

CodeBearer(Required scopes: pockets.read)

Query

type[]Array of strings or null(Type[])

Any of:

Array of strings

status[]Array of strings or null(Status[])

Any of:

Array of strings

cursorstring(Cursor)

Default:""

limitinteger, [ 1 .. 100 ](Limit)

Default:30

curl -i -X GET \
  'https://api.business.jiko.io/api/v2/portals/?type%5B%5D=VIRTUAL_BANK_ACCOUNT_PORTAL&status%5B%5D=OPEN&cursor=&limit=30' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json

prev_pagestring or null(Prev Page)

Any of:

string

next_pagestring or null(Next Page)

Any of:

string

itemsArray of any(Items)required

object_typestring(Object Type)

Default:"CursorList"

Response

{
  "prev_page": "string",
  "next_page": "string",
  "items": [
    { … }
  ],
  "object_type": "CursorList"
}