List Users

List Users

curl --request GET \
  --url https://api.attention.tech/v2/users \
  --header 'Authorization: <api-key>'

{
  "data": [
    {
      "botName": "Karen's Notetaker",
      "email": "[email protected]",
      "firstName": "Karen",
      "lastName": "Doe",
      "primaryTeamUUID": "4b56088c-110d-486b-b4f9-f1d6eb1927cf",
      "roles": [
        {
          "name": "Admin",
          "type": "ADMIN",
          "uuid": "84e67f54-5157-442b-a2b3-8b9c728b2fef"
        },
        {
          "name": "Sales Representative",
          "type": "SALES_REP",
          "uuid": "e28b72c8-a4f4-446c-92d9-2483acab3c71"
        }
      ],
      "settings": {
        "joinWhenIAmHostAndAlone": true,
        "joinWhenIAmHostWithPeers": true,
        "realTimeCapabilitiesOFF": true
      },
      "teams": [
        {
          "children": [],
          "domain": "attention.tech",
          "name": "teamA5",
          "organizationUUID": "16b78cec-82ef-46d2-8213-5d3bb7d2571c",
          "parentTeamUUID": "38dd31c6-8fc3-45ed-acc0-86567f13d296",
          "uuid": "4b56088c-110d-486b-b4f9-f1d6eb1927cf"
        },
        {
          "children": [],
          "domain": "attention.tech",
          "name": "A3",
          "organizationUUID": "16b78cec-82ef-46d2-8213-5d3bb7d2571c",
          "parentTeamUUID": "2ccf9bde-68e3-4de4-bc4e-51b927336665",
          "uuid": "d350b24c-70bc-424e-9ae6-06afdba616fc"
        },
        {
          "children": [],
          "domain": "Wrapbook.com",
          "name": "de wrapbook",
          "organizationUUID": "43c2c551-279c-4a2a-a84f-b43f06328e8b",
          "uuid": "24c426ca-9a14-4c84-8225-5a02e253f505"
        }
      ],
      "transcriptLang": "en",
      "uuid": "ccef8743-8f86-416b-9c62-a7eaa026f31d"
    },
    {
      "botName": "test's Notetaker",
      "email": "[email protected]",
      "firstName": "Jhon",
      "joinOutsideHostMeetings": true,
      "lastName": "Doe",
      "primaryTeamUUID": "4b56088c-110d-486b-b4f9-f1d6eb1927cf",
      "roles": [
        {
          "name": "Sales Representative",
          "type": "SALES_REP",
          "uuid": "e28b72c8-a4f4-446c-92d9-2483acab3c71"
        }
      ],
      "settings": {
        "joinWhenIAmHostAndAlone": true,
        "joinWhenIAmHostWithPeers": true,
        "realTimeCapabilitiesOFF": true
      },
      "teams": [
        {
          "children": [],
          "domain": "attention.tech",
          "name": "A3",
          "organizationUUID": "16b78cec-82ef-46d2-8213-5d3bb7d2571c",
          "parentTeamUUID": "2ccf9bde-68e3-4de4-bc4e-51b927336665",
          "uuid": "d350b24c-70bc-424e-9ae6-06afdba616fc"
        },
        {
          "children": [],
          "domain": "Wrapbook.com",
          "name": "de wrapbook",
          "organizationUUID": "43c2c551-279c-4a2a-a84f-b43f06328e8b",
          "uuid": "24c426ca-9a14-4c84-8225-5a02e253f505"
        }
      ],
      "transcriptLang": "en",
      "uuid": "8e288333-f634-4659-a57a-251bb4f51726"
    }
  ]
}

GET

users

List Users

curl --request GET \
  --url https://api.attention.tech/v2/users \
  --header 'Authorization: <api-key>'

{
  "data": [
    {
      "botName": "Karen's Notetaker",
      "email": "[email protected]",
      "firstName": "Karen",
      "lastName": "Doe",
      "primaryTeamUUID": "4b56088c-110d-486b-b4f9-f1d6eb1927cf",
      "roles": [
        {
          "name": "Admin",
          "type": "ADMIN",
          "uuid": "84e67f54-5157-442b-a2b3-8b9c728b2fef"
        },
        {
          "name": "Sales Representative",
          "type": "SALES_REP",
          "uuid": "e28b72c8-a4f4-446c-92d9-2483acab3c71"
        }
      ],
      "settings": {
        "joinWhenIAmHostAndAlone": true,
        "joinWhenIAmHostWithPeers": true,
        "realTimeCapabilitiesOFF": true
      },
      "teams": [
        {
          "children": [],
          "domain": "attention.tech",
          "name": "teamA5",
          "organizationUUID": "16b78cec-82ef-46d2-8213-5d3bb7d2571c",
          "parentTeamUUID": "38dd31c6-8fc3-45ed-acc0-86567f13d296",
          "uuid": "4b56088c-110d-486b-b4f9-f1d6eb1927cf"
        },
        {
          "children": [],
          "domain": "attention.tech",
          "name": "A3",
          "organizationUUID": "16b78cec-82ef-46d2-8213-5d3bb7d2571c",
          "parentTeamUUID": "2ccf9bde-68e3-4de4-bc4e-51b927336665",
          "uuid": "d350b24c-70bc-424e-9ae6-06afdba616fc"
        },
        {
          "children": [],
          "domain": "Wrapbook.com",
          "name": "de wrapbook",
          "organizationUUID": "43c2c551-279c-4a2a-a84f-b43f06328e8b",
          "uuid": "24c426ca-9a14-4c84-8225-5a02e253f505"
        }
      ],
      "transcriptLang": "en",
      "uuid": "ccef8743-8f86-416b-9c62-a7eaa026f31d"
    },
    {
      "botName": "test's Notetaker",
      "email": "[email protected]",
      "firstName": "Jhon",
      "joinOutsideHostMeetings": true,
      "lastName": "Doe",
      "primaryTeamUUID": "4b56088c-110d-486b-b4f9-f1d6eb1927cf",
      "roles": [
        {
          "name": "Sales Representative",
          "type": "SALES_REP",
          "uuid": "e28b72c8-a4f4-446c-92d9-2483acab3c71"
        }
      ],
      "settings": {
        "joinWhenIAmHostAndAlone": true,
        "joinWhenIAmHostWithPeers": true,
        "realTimeCapabilitiesOFF": true
      },
      "teams": [
        {
          "children": [],
          "domain": "attention.tech",
          "name": "A3",
          "organizationUUID": "16b78cec-82ef-46d2-8213-5d3bb7d2571c",
          "parentTeamUUID": "2ccf9bde-68e3-4de4-bc4e-51b927336665",
          "uuid": "d350b24c-70bc-424e-9ae6-06afdba616fc"
        },
        {
          "children": [],
          "domain": "Wrapbook.com",
          "name": "de wrapbook",
          "organizationUUID": "43c2c551-279c-4a2a-a84f-b43f06328e8b",
          "uuid": "24c426ca-9a14-4c84-8225-5a02e253f505"
        }
      ],
      "transcriptLang": "en",
      "uuid": "8e288333-f634-4659-a57a-251bb4f51726"
    }
  ]
}

Authorizations

Authorization

string

header

required

Query Parameters

filter[id]

string[]

filter[email]

string[]

teamUUID

string

includeDeleted

boolean

default:false

Response

users successfully returned

data

object[]

Show child attributes

data.uuid

string

The unique identifier of the user.

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.email

string

The email address of the user.

Example:

"[email protected]"

data.firstName

string

The first name of the user.

Example:

"John"

data.lastName

string

The last name of the user.

Example:

"Doe"

data.createdAt

string

The date and time the user was created.

Example:

"2021-01-01T00:00:00Z"

data.deletedAt

string

The date and time the user was deactivated.

Example:

"2021-01-01T00:00:00Z"

data.transcriptLang

string

The preferred transcript language for the user.

Example:

"en-US"

data.joinOutsideHostMeetings

boolean

Indicates if the user can join meetings outside their host organization.

Example:

true

data.realTimeCapabilities

boolean

Indicates if the user has real-time transcription capabilities.

Example:

false

data.settings

object

Show child attributes

data.settings.realTimeCapabilitiesOFF

boolean

data.settings.autoCalculateCRMFields

boolean

data.settings.joinWhenIAmHostAndAlone

boolean

data.settings.joinWhenIAmHostWithPeers

boolean

data.settings.joinWhenPeerIsHost

boolean

data.settings.joinWhenUnlicensedPeerIsHost

boolean

data.settings.dealsEnabled

boolean

Example:

{
  "realTimeCapabilitiesOFF": true,
  "autoCalculateCRMFields": true,
  "joinWhenIAmHostAndAlone": true,
  "joinWhenIAmHostWithPeers": true,
  "joinWhenPeerIsHost": true,
  "joinWhenUnlicensedPeerIsHost": true,
  "dealsEnabled": true
}

data.botName

string

The name of the bot associated with the user.

Example:

"MyBot"

data.botImageURL

string

The URL of the bot's profile image.

Example:

"https://example.com/bot.png"

data.primaryTeamUUID

string

The UUID of the user's primary team.

Example:

"primary-team-uuid-12345"

data.organizationRoleUUID

string

The UUID of the user's role in the organization.

Example:

"org-role-uuid-56789"

data.roles

object[]

A list of roles assigned to the user.

Show child attributes

data.roles.uuid

string

data.roles.name

string

data.roles.type

string

data.showReferralScreen

boolean

Whether the user is shown a referral screen.

Example:

false

data.seatType

string

The type of seat assigned to the user.

Example:

"admin"

data.teams

object[]

A list of teams assigned to the user.

Show child attributes

data.teams.uuid

string

Unique identifier of the team

Example:

"fe515723-fe2e-4959-a5fa-c4d3937fe7e4"

data.teams.name

string

Name of the team

Example:

"Engineering"

data.teams.phrases

string[]

List of keywords or phrases associated with the team

Example:

["engineering", "tech", "development"]

data.teams.slackConnection

object

Represents the Slack integration details for a team

Show child attributes

data.teams.slackConnection.id

string

Slack connection identifier

Example:

"T1234567890"

data.teams.slackConnection.info

object

Information about a connected Slack team

Show child attributes

data.teams.slackConnection.info.id

string

Slack team identifier

Example:

"T1234567890"

data.teams.slackConnection.info.name

string

Name of the Slack team

Example:

"Attention Tech"

data.teams.domain

string

Domain associated with the team

Example:

"attention.tech"

data.teams.organizerJoinInternalMeetings

boolean

Whether team organizers can join internal meetings

Example:

true

Whether email consent is enabled for the team

Example:

true

data.teams.parentTeamUUID

string

UUID of the parent team if this team is part of a hierarchy

Example:

"2ccf9bde-68e3-4de4-bc4e-51b927336665"

data.teams.organizationUUID

string

UUID of the organization this team belongs to

Example:

"16b78cec-82ef-46d2-8213-5d3bb7d2571c"

data.teams.children

array

List of child teams if this team has a hierarchical structure

links

object

Show child attributes

links.self

string

Example:

{
  "self": "https://api.attention.tech/v2/conversations/123",
  "related": "https://api.attention.tech/v2/conversations/123/participants"
}

Delete api key List emails

⌘I

Authentication

GI

Conversation

Team

ApiKey

User

Email

Tool

Scorecard

Opportunity

Organization

Calendar

Scim

Authorizations

Query Parameters

Response