/peopleRelationships

Get relationships between people in Follow Up Boss.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Relationship information available with /v1/people

If you are already using /v1/people , it will include the email addresses and phone numbers of associated relationships. To include relationship information within /v1/people , add relationships to the fields query parameter of /v1/people.

This means for many use cases, /v1/people can still be primarily used to gather all pertinent information about a person and their relationships.

📘

isPriority

The isPriority boolean indicates that the type for this relationship is considered a priority for the current industry of the account. For example, isPriority is true occurs when the type indicates a spousal relationship with values such as wife, husband, spouse, etc.

Query Params
string

The sort order. Can be one of the following: id, created, updated, name, firstName, lastName, personId.

int32

Filter relationships by a person ID.

string

Searches for person with a name like what is given. (e.g., If you search for drew, it might return a contact like Andrew.)

string

Searches for person with a first name like what is given. (e.g., If you search for drew, it might return a contact like Andrew.)

string

Searches for person with a last name like what is given. (e.g., If you search for drew, it might return a contact like Andrew.)

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json