List Contacts

get

https://sandbox-api.getbrass.co/contacts

List and optionally search contact records

Query Params

include

string

Optional comma-separated list of relationships to include

page

int32

Defaults to 1

The page of results to retrieve

limit

int32

Defaults to 10

The maximum number of records to fetch

string

Optional query to filter the list of contacts

tag

string

Resource id of the tag to filter for; when this is provided, only contacts with this tag are fetched

with_beneficiaries

string

enum

Defaults to 0

By default, beneficiaries - people money has been sent to but aren't saved to avoid fees - aren't included. You can enable this so you search through everyone you've sent money to when creating a payment

Allowed:

exclude_contacts

string

enum

Defaults to 0

When you want to only retrieve a list of beneficiaries alone, you should enable both this and the with_beneficiaries flags

Allowed:

Headers

Authorization

string

required

Defaults to Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJhdXRoLmdldGJyYXNzLmNvIiwiZXhwIjoxNjA4ODkwMzY2LCJpYXQiOjE2MDg4ODY3NjYsIm5iZiI6MTYwODg4Njc2NiwiYXBpX2NsaWVudCI6ImFwcF82OEQ0eTJ3d1V0aENNV3BrTXZ5WjRZIiwiY3VzdG9tZXIiOiJjdXNfMUdkbDNjQzE0eTZuVU9veE9QaFBjeiIsInVzZXIiOiJ1c3JfdndyVnNIckh3cnluWE85c01yZHB4In0.kfovIfs42zECgTC3k2wLh3gTq8mYN-nU9aL13U-EJZ_fN1GHd1N8Tid2vpF-ZJ-UwUdEKc2eFJjfe94u_NFIE1vs1Gh-Wr-kzC3OY5X4ADesPEQ1OFPsBknnQmMpE8-KHydza_V19eetgClhX8YytWuFNGBByLPYtD5h2Fw-FCk

An auth level 2 token to authorize the call

Response

Language

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200