Skip to main content
GET
/
v1
/
payers
List payers
curl --request GET \
  --url https://api.example.com/v1/payers \
  --header 'Authorization: Bearer <token>'
{
  "payers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "name": "<string>",
      "company": "<string>",
      "country": "<string>",
      "active": true,
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modified_at": "2023-11-07T05:31:56Z",
      "modified_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "total": 123,
  "has_more": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.corebanq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:20

Maximum number of records to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of records to skip

Required range: x >= 0
​
company
string

Filter by company name

​
country
string

Filter by ISO3 country code

Pattern: ^[A-Z]{3}$
​
active
boolean

Filter by active status

Response

200 - application/json

List of payers

​
payers
object[]
​
total
integer

Total number of records

​
has_more
boolean

Whether more records exist