get
https://api.marketcircle.net/v1/relationship_types
List all relationship types
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Relationships types describe the nature of the directed link between two contacts or two companies. Each relationship type has a forward and reverse component, and a forward and reverse title that applies to the source and destination objects in the relationship.
Attributes
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
self | reference | URL of the Relationship Type | Read-only Non-null |
forward | string | Forward component of the Relationship Type | Read-Write Nullable |
reverse | string | Reverse component of the Relationship Type | Read-Write Nullable |
Filtering Results
This endpoint returns the full list of Relationship Types by default. However, you may include an entity query parameter to only fetch Relationship Types which are enabled for the entity.
An example request that only wanted categories for Contact would like this:
GET /v1/relationship_types?entity=contactAll entities which support categories are valid values for the entity filter: