Skip to content
Patrimoine
v9.1.0

List Payees Endpoint

GET
/api/v1/payees
curl --request GET \
  --url 'https://example.com/api/v1/payees?sort_by=name&sort_dir=asc&limit=50&offset=0'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
Any of:
string
<= 100 characters
ids
Any of:
Array<integer>
<= 100 items
sort_by
Sort By
string
default: name
Allowed values: name usage
sort_dir
Sort Dir
string
default: asc
Allowed values: asc desc
limit
Limit
integer
default: 50 >= 1 <= 250
offset
Offset
integer
0

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Payees Endpoint Api V1 Payees Get
Array<object>
PayeeOut
object
id
required
Id
integer
user_id
required
User Id
integer
name
required
Name
string
default_category_id
required
Any of:
integer
default_subcategory_id
required
Any of:
integer
aliases
Aliases
Array<string>
default:
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
usage_count
Usage Count
integer
0
planned_transaction_count
Planned Transaction Count
integer
0

Example 

[
  {
    "aliases": [],
    "usage_count": 0,
    "planned_transaction_count": 0
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}