Portals

Web portals allow your contacts to choose how to pay their debt from their mobile phone.

Fields

class Portal
created_at: datetime

The portal’s creation date and time.

id: integer

The portal’s unique ID.

name: string

The portal’s name.

team: integer

The portal’s team.

API

GET /j/portals

Retrieves the list of portals.

Request Headers:
Query Parameters:

  • team (integer) – An optional team ID.

Response JSON Array of Objects:

  • created_at (datetime) – The portal’s creation date and time.

  • id (integer) – The portal’s unique ID.

  • name (string) – The portal’s name.

  • team (integer) – The portal’s team.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request – for instance a required field is missing

  • 403 Forbidden – you tried to access a forbidden resource, check you provided a valid OAuth token