Brex Developer API Documentation
List referrals
GET {{api_url}}/v1/referrals
Returns referrals created.
Note: This doesn't include referrals that have expired
Body
PARAM
| Key | Datatype | Required | Description |
cursor
|
string |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"items": [
{
"expires_at": "1948-10-25T02:47:00.608Z",
"id": "commodo ad officia et",
"products": [
{
"cash": {
"accounts": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
]
}
},
{
"cash": {
"accounts": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
]
}
}
],
"referral_signup_url": "exercitation anim ut esse",
"status": "CLOSED"
},
{
"expires_at": "1959-03-13T08:18:04.539Z",
"id": "sed amet non occaecat",
"products": [
{
"cash": {
"accounts": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
]
}
},
{
"cash": {
"accounts": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
]
}
}
],
"referral_signup_url": "mollit incididunt esse",
"status": "EXPIRED"
}
],
"nextCursor": "consequat laboris qui ad Duis"
} |
Curl
curl -X GET 'api_url/v1/referrals?cursor=<string>'
ENDPOINTS