Skip to main content

Team APIs

Our customers use Backstory to manage all GTM users and their settings in the application. We are introducing access to the Team setup you have in our application.

Team APIs will enable you to aggregate activities or account/opportunity data by users in the application and manage the scope of data based on configuration profiles set for each user.

How to make a request

Path

Return all team members

Path

/v0/public/team-members/team-id/{id}

Return all team members of the given team

Path

/v0/public/team-members/{id}

Return a specific team member by id

Path

/v0/public/team-members/crm-id/{id}

Return a specific team member by crm-id

Path

/v0/public/team-members/email/{id}

Return a specific team member by email

Method

GET

Pagination

Yes

Number of team members in response

Schema

Field

Type

Description

crm_id

string

Unique CRM identifier for the team member

email

string

Email address for a team member

first_name

string

First name for a team member

last_name

string

Last name for a team member

team_id

integer

Unique Backstory identifier for the team

parent_team_id

integer

Unique Backstory identifier for the team’s parent team

team_name

string

Team name of the member

id

integer

Unique Backstory identifier for the team member

active

boolean

States if the team member is active in the application

deleted

boolean

States if the team member was deleted from the application

suspended

boolean

States if the team member is suspended from the application

job_title

string

Job title for a team member

role

object

CRM role information

role.crm_id

string

Unique CRM identifier of role

role.name

string

CRM role name

role.status

string

CRM role status

profile_name

string

Member profile name

profile_id

integer

Unique Backstory identifier for profile

Did this answer your question?