Admins

Admins are users with special permissions to manage your Featurebase organization. On this page, we'll explore the different admin endpoints you can use to retrieve admin information programmatically.

The admin model

The Admin model contains information about users who have admin permissions in your Featurebase organization. This includes their personal information, role, and associated permissions.

Properties

Name
id
Type
string
Description
The unique identifier of the admin. Example: "5fef50c5e9458a0012f82456"
Name
name
Type
string
Description
The name of the admin.
Name
email
Type
string
Description
The email address of the admin.
Name
picture
Type
string
Description
The URL to the profile picture of the admin.
Name
roleId
Type
string
Description
The unique identifier of the admin's role.

GET/v2/admins

List admins

This endpoint allows you to retrieve a list of all admins for your Featurebase organization.

Request

GET

/v2/admins

curl -G https://do.featurebase.app/v2/admins \
  -H "X-API-Key: {token}"

Response

{
  "success": true,
  "results": [
    {
      "id": "5fef50c5e9458a0012f82456",
      "name": "First Admin",
      "email": "first_admin@example.com",
      "picture": "https://6595518396205e06b897ad65.featurebase-attachments.com/c/static/0195be85-2d96-724c-8396-97b87beacdab/me0n7he75n.png",
      "roleId": "6648f22b7b23fb2f4307aafe"
    },
    {
      "id": "5febde0bdc56d60012d47db5",
      "name": "Second Admin",
      "email": "brunohiis@gmail.com",
      "picture": "https://6595518396205e06b897ad65.featurebase-attachments.com/c/static/0195be85-2d96-724c-8396-97b87beacdab/me0n7he75n.png",
      "roleId": "6648f22b7b23fb2f4307aafe"
    },
    {
      "id": "5febdbb7b36fdd00129617c4",
      "name": "Third Admin",
      "email": "rohumaarobi@gmail.com",
      "picture": "https://6595518396205e06b897ad65.featurebase-attachments.com/c/static/0195be85-2d96-724c-8396-97b87beacdab/me0n7he75n.png",
      "roleId": "6648f22b7b23fb2f4307aafe"
    }
  ]
}

GET/v2/admins/:id

Get admin by ID

This endpoint allows you to retrieve details for a specific admin by providing their unique identifier.

Required URL Parameters

Name
id
Type
string
Description
The unique identifier of the admin to retrieve.

Request

GET

/v2/admins/:id

curl -G https://do.featurebase.app/v2/admins/5fef50c5e9458a0012f82456 \
  -H "X-API-Key: {token}"

Response

{
  "id": "5fef50c5e9458a0012f82456",
  "name": "First Admin",
  "email": "first_admin@example.com",
  "picture": "https://6595518396205e06b897ad65.featurebase-attachments.com/c/static/0195be85-2d96-724c-8396-97b87beacdab/me0n7he75n.png",
  "roleId": "6648f22b7b23fb2f4307aafe"
}

GET/v2/admins/roles

List admin roles

This endpoint allows you to retrieve a list of all available admin roles and their associated permissions.

Request

GET

/v2/admins/roles

curl -G https://do.featurebase.app/v2/admins/roles \
  -H "X-API-Key: {token}"

Response

{
  "success": true,
  "results": [
    {
      "name": "Admin",
      "permissions": {
        "view_comments_private": true,
        "manage_comments": true,
        "manage_comments_private": true,
        "set_comment_pinned": true,
        "moderate_comments": true,
        "set_post_category": true,
        "set_post_pinned": true,
        "set_post_eta": true,
        "set_post_tags": true,
        "set_post_author": true,
        "set_post_status": true,
        "set_post_assignee": true,
        "set_post_custom_fields": true,
        "post_vote_on_behalf": true,
        "post_merge": true,
        "post_import": true,
        "post_export": true,
        "moderate_posts": true,
        "view_users": true,
        "manage_users": true,
        "view_posts_private": true,
        "view_private_post_tags": true,
        "manage_changelogs": true,
        "manage_surveys": true,
        "manage_branding": true,
        "manage_billing": true,
        "manage_team_members": true,
        "manage_sso": true,
        "manage_api": true,
        "manage_statuses": true,
        "manage_boards": true,
        "manage_post_tags": true,
        "manage_custom_fields": true,
        "manage_moderation_settings": true,
        "manage_roadmap": true,
        "manage_user_roles": true,
        "manage_prioritization": true,
        "manage_notifications": true,
        "manage_custom_domain": true,
        "manage_integrations": true,
        "use_integrations": true,
        "manage_help_center": false,
        "auto_approve_posts": true
      },
      "_id": "6648f22b7b23fb2f4307aafe"
    }
  ]
}