Understanding the CRM Concept

CRM is a technology for managing all your company´s relationships and interactions with existing customers and potential customers. For managing this information Pipeliner provides CRM users with different objects representation and relationships between them. Pipeliner calls the main objects Entities.

Entities

Entities help to map company sales business processes in the CRM. In Pipeliner, there exist following Entities

Entities management inside Pipeliner Application

Main Entities

• Accounts (Endpoints: {{baseURL}}/entities/Accounts)

  • accounts stores Company information (industry, company size, contacts). See how to create an Account
• Contacts (Endpoints: {{baseURL}}/entities/Contacts)

  • contacts refer to people who have a relation to a specific Account. See how to create a Contact
• Opportunities (Endpoints: {{baseURL}}/entities/Opportunities)

  • represents existing or potential business revenue with Contact or Account. Opportunities have to move through several stages in Pipeline. See how to create an Opportunity
• Leads (Endpoints: {{baseURL}}/entities/Leads)

  • represents the potential business to your company

• Activities

  • Represents Tasks and Appointments together. Tasks are one-time activities that usually don´t have duration. We can refer to Appointments as meeting with duration.

    • Appointments (Endpoint: {{baseURL}}/entities/Appointments)

    • Tasks: (Endpoint: {{baseURL}}/entities/Tasks)

• Products (Endpoints: {{baseURL}}/entities/Products)

  • Represents physical items that your sales team is selling. See how to create Products
• Product Line Items (Endpoints: {{baseURL}}/entities/OpptyProductRelations)

  • Represents product that is being currently sold by your sales team. Product Line items are direct connections between Opportunity and Physical Product. See how to work with Product Line items

Other data

• Notes

• Documents (Endpoints: {{baseURL}}/entities/CloudObjects)
• Messages

To get {{baseURL}} read About the API

Creating Relations between entities

Entities in the CRM are linked between themselves with relations. Take a look at the entity-relationship diagram to understand the connections that can exist.

Fields

Fields represent a property of Entity where end-users(salespeople) store information like (Name, Opportunity Value, Industry...). Pipeliner works with System Fields (defined by the Pipeliner system) and Custom Fields (defined by business people). Learn more about working with fields.

Users & Roles & Sales units (Accessing Records)

Users, roles, sales units determine what users can see inside the Pipeliner application. At the top of the hierarchy is the Role, which includes 0..N users. Those Users can be part of the N Sales Units. To understand how roles, users, sales unit works read this article.

Role

Api name: master_right

Users are part of the Role. Users can be assigned only to one Role. The role determines what data, features the User can access.

Example of Roles: Standard Users, Administrators, Salespeople

get

Returns all defined MasterRights

Query parameters

include-deletedbooleanOptional

if enabled, deleted MasterRights are returned as well

firstinteger · int32Optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

lastinteger · int32Optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

beforebooleanOptional

Cursor until which to take entities to result set.

afterbooleanOptional

Cursor after which to start taking entities to result set.

expandstringOptional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example: expand=owner,sales_unit,account_relations.account

order-bystringOptional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example: order-by=created,-modified

filterobjectOptional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

Example: filter[name]=Example

filter-opobjectOptional

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

Example: filter-op[name]=eq

load-onlystringOptional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example: load-only=id,name,owner.id

Responses

200

list of MasterRights

application/json

500

unexpected error

application / json

get

HTTPcURLJavaScriptPython

GET /api/v100/rest/spaces/<space_id>/entities/MasterRights HTTP/1.1
Host: us-east.pipelinersales.com
Accept: */*

{
  "success": true,
  "data": [],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

User

Api name: client

Users are real people who have access to the Pipeliner CRM space. Users usually get a direct invitation to the space from the space admin. The user unique identification is email_address.

Users can be assigned to the Entity Records. Users who are assigned to the records are called Owners. Owners are required on the majority of entities. Only Leads and Activities can be unassigned (without an Owner).

Every user has a default_unit attribute. You can use this attribute when creating records in Pipeliner.

get

Returns all defined Clients

Query parameters

include-deletedbooleanOptional

if enabled, deleted Clients are returned as well

firstinteger · int32Optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

lastinteger · int32Optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

beforebooleanOptional

Cursor until which to take entities to result set.

afterbooleanOptional

Cursor after which to start taking entities to result set.

expandstringOptional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example: expand=owner,sales_unit,account_relations.account

order-bystringOptional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example: order-by=created,-modified

filterobjectOptional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

Example: filter[name]=Example

filter-opobjectOptional

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

Example: filter-op[name]=eq

load-onlystringOptional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example: load-only=id,name,owner.id

Responses

200

list of Clients

application/json

500

unexpected error

application / json

get

HTTPcURLJavaScriptPython

GET /api/v100/rest/spaces/<space_id>/entities/Clients HTTP/1.1
Host: us-east.pipelinersales.com
Accept: */*

{
  "success": true,
  "data": [],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

Sales Unit

Api name: unit

Sales units from a business point of view are groups of users with similar traits. Sales units works in the hierarchy. Pipeliner admin defines this hierarchy based on the business requirements. Sales units can refer to territory, team, business unit.

Example of Sales units: Canada, Europe -> UK, Germany, France

Every Entity has to be connected with the Sales Unit. Even when the record is Unassigned. It is recommended to use the Client (User) default sales Unit.

System Sales Unit

The Companysales Unit is System Sales Unit. It is always at the top of the hierarchy and you can always assign entity records to this Sales Unit. Company Sales Unit has always attribute parent:null

{
            "is_delete_protected": false,
            "id": "ea33e8fb-9a56-4802-a175-2d1f406af7cf",
            "is_deleted": false,
            "modified": "2019-02-01 13:17:03.495636+00:00",
            "created": "2019-01-30 11:06:54.115137+00:00",
            "parent": null,
            "picture": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/CloudObjects/74cc1d77-11d7-455d-9c32-39065f269e1b",
            "name": "Company ",
            "parent_id": null,
            "picture_id": "74cc1d77-11d7-455d-9c32-39065f269e1b",
            "revision": 816
        }

get

Returns all defined SalesUnits

Query parameters

include-deletedbooleanOptional

if enabled, deleted SalesUnits are returned as well

firstinteger · int32Optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

lastinteger · int32Optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

beforebooleanOptional

Cursor until which to take entities to result set.

afterbooleanOptional

Cursor after which to start taking entities to result set.

expandstringOptional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example: expand=owner,sales_unit,account_relations.account

order-bystringOptional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example: order-by=created,-modified

filterobjectOptional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

Example: filter[name]=Example

filter-opobjectOptional

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

Example: filter-op[name]=eq

load-onlystringOptional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example: load-only=id,name,owner.id

Responses

200

list of SalesUnits

application/json

500

unexpected error

application / json

get

HTTPcURLJavaScriptPython

GET /api/v100/rest/spaces/<space_id>/entities/SalesUnits HTTP/1.1
Host: us-east.pipelinersales.com
Accept: */*

{
  "success": true,
  "data": [],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}