Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Teammates

Get teammate

Fetch a teammate.

Required scope: teammates:read

get/teammates/{teammate_id}

Path parameters

teammate_idstring required

The teammate ID. Alternatively, you can supply an email as a resource alias.

Response

A teammate

idstring required

Unique identifier of the teammate

emailstring required

Email address of the teammate

usernamestring required

Username of the teammate (used for "@" mentions)

first_namestring required

First name of the teammate

last_namestring required

Last name of the teammate

is_adminboolean required

Whether or not the teammate is an admin in your company

is_availableboolean required

Whether or not the teammate is available

is_blockedboolean required

Whether or not the teammate account has been blocked

type'user' | 'visitor' | 'ai' | 'api' | 'application' | 'bulk_reply' | 'csat' | 'integration' | 'macro' | 'rule' | 'smart_csat' required

Type of the teammate, normal teammates are denoted as "user", while visitors are denoted as "visitor". Bot users are denoted by their parent resource type. The following bot types are available:

  • ai: acting on behalf of an AI
  • api: acting on behalf of OAuth clients
  • application: acting on behalf of an Application
  • bulk_reply: acting on behalf of a Bulk Reply
  • csat: used for authoring CSAT response comments
  • integration: acting on behalf of an Integration
  • macro: acting on behalf of a Macro, author of comments and drafts
  • rule: acting on behalf of a Rule, author of comments and drafts
  • smart_csat: acting on behalf of a Smart CSAT
custom_fieldsCustomFieldParameter required

An object whose key is the name property defined for the custom field in the Front UI. The value of the key must use the same type specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a",
    "related": {
      "inboxes": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/inboxes",
      "conversations": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/conversations",
      "botSource": "https://yourCompany.api.frontapp.com/rules/rul_6r55a"
    }
  },
  "id": "tea_6r55a",
  "email": "michael.scott@dundermifflin.com",
  "username": "PrisonMike",
  "first_name": "Michael",
  "last_name": "Scott",
  "is_admin": true,
  "custom_fields": {
    "city": "London, UK",
    "isVIP": true,
    "renewal_date": 1525417200,
    "sla_time": 90,
    "owner": "leela@planet-express.com",
    "replyTo": "inb_55c8c149",
    "Job Title": "firefighter"
  }
}