Actions148
- Action Plan Actions
- Action Plan Assignment Actions
- Appointment Actions
- Appointment Outcome Actions
- Appointment Type Actions
- Automation Actions
- Automation Assignment Actions
- Call Actions
- Custom Field Actions
- Deal Actions
- Deal Attachment Actions
- Deal Custom Field Actions
- Deal Pipeline Actions
- Email Marketing Campaign Actions
- Email Marketing Event Actions
- Email Template Actions
- Event Actions
- Group Actions
- Identity Actions
- Note Actions
- People Relationship Actions
- Person Actions
- Person Attachment Actions
- Pond Actions
- Reaction Actions
- Smart List Actions
- Stage Actions
- Task Actions
- Team Actions
- Team Inbox Actions
- Text Message Actions
- Text Message Template Actions
- Threaded Reply Actions
- Timeframe Actions
- User Actions
People Relationship → Get
AI-generatedSummary
Retrieve a people relationship record from Follow Up Boss.
Inputs
- authentication — Authentication method for the API request. Defaults to API Key. Options: API Key or OAuth2.
- relationshipId (required) — ID of the relationship to retrieve. Choose from the list or specify an ID.
Output shape
object
Returns the people relationship data from the Follow Up Boss API corresponding to the specified ID or list selection.
Examples
Example 1: Retrieve by numeric ID
Set authentication to API Key and relationshipId.id to a numeric string matching [0-9]+.
Example 2: Retrieve from list
Set authentication to API Key and relationshipId.list to a selected relationship from the getPeopleRelationships list.