Skip to main content
GET
/
v1
/
purposes
List Account Purposes
curl --request GET \
  --url https://sandbox.api.fin.com/v1/purposes \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "pagination": {
      "current_page": 1,
      "per_page": 10,
      "total_page": 1,
      "total": 10
    },
    "purposes": [
      {
        "id": 1,
        "title": "Personal Savings"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Obtain token from Issue a Token endpoint

Query Parameters

​
per_page
integer
default:10

Number of items to return per page

Required range: 1 <= x <= 512
​
current_page
integer
default:1

The page number to retrieve

Required range: x >= 1
​
type
enum<string>
required

Filter account purposes by type

Available options:
INDIVIDUAL,
BUSINESS

Response

List of account purposes retrieved successfully

​
data
object