get
https://api.marketcircle.net/v1/role_types/
Get a role type's details
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Attributes
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
self | reference | URL of the role type | Read-only Non-null |
role_name | string | Name of the role type, e.g. Decision Maker (max 128 characters) | Read-Write Non-null Required Searchable |
is_active | boolean | true if the role type can be assigned | Read-Write Non-null Default value is trueSearchable |
entities | array of string | The types of record the role type can be used with: any of Contact, Company, Opportunity and Project. Searchable as for_contact, for_company, for_opportunity and for_project | Read-Write Non-null Default value is all four Searchable |
create_date | datetime | When the role type was created | Read-only Non-null |
The following table outlines the ways in which the various objects may be related to one another using roles.
| Entity | Relatable To |
|---|---|
| Contact | Company, Opportunity, Project |
| Company | Contact, Opportunity, Project |
| Opportunity | Company, Contact |
| Project | Company, Contact |
When a role is given a role name that doesn't exist yet, a role type with that name is created automatically.