Skip to main content

​
Fetch Group

​
Overview

Retrieve details of a specific group by its ID.

Playground

​
Endpoint

GET /api/content/v2/groups/{group}

​
Path Parameters

ParameterTypeRequiredDescription
groupStringYesThe ID of the group to fetch

​
Request Example

GET https://{instance}.domo.com/api/content/v2/groups/{group}
Headers:
  X-DOMO-Developer-Token: <token>
  Content-Type: application/json

​
Response Example

Status Code: 200 
{
  "id": 6789456782,
  "name": "Group Name",
  "type": "closed",
  "userIds": [
    123123123,
    342342344,
    555543423,
    432423423
  ],
  "creatorId": 4421231232,
  "memberCount": 4,
  "guid": "guid-goes-here",
  "description": "",
  "hidden": false,
  "default": false,
  "active": true
}

​
Fetch User Details

​
Overview

Fetch detailed information for a specific user by their ID.

Playground

​
Endpoint

GET /api/identity/v1/users/{userId}

​
Path Parameters

ParameterTypeRequiredDescription
userIdStringYesThe ID of the user

​
Query Parameters

ParameterTypeRequiredDescription
partsStringNoSpecifies the detail level, e.g., detailed

​
Request Example

GET https://{instance}.domo.com/api/identity/v1/users/{userId}?parts=detailed
Headers:
  X-DOMO-Developer-Token: <token>
  Content-Type: application/json

​
Response Example

Status Code: 200 
[
  {
    "name": "Domo User",
    "id": 3817263817,
    "location": "",
    "manager": "",
    "phoneNumber": "+phone number",
    "title": "Software Engineer"
  }
]

​
Create a Group

​
Overview

Create a new group with the specified details.

Playground

​
Endpoint

POST /api/content/v2/groups

​
Body Parameters

ParameterTypeRequiredDescription
nameStringYesName of the group
descriptionStringNoDescription of the group
typeStringYesGroup type: closed, open, or dynamic

​
Request Example

POST https://{instance}.domo.com/api/content/v2/groups
Headers:
  X-DOMO-Developer-Token: <token>
  Content-Type: application/json
body:
{
  "name": "New Group",
  "description": "This is a new group",
  "type": "closed"
}

​
Response Example

Status Code: 200 
{
  "id": "123123123"
}

​
Add People to a Group

​
Overview

Add a user to a specific group.

Playground

​
Endpoint

PUT /api/content/v2/groups/{group}/user/{userId}

​
Path Parameters

ParameterTypeRequiredDescription
groupStringYesThe ID of the group
userIdStringYesThe ID of the user to add to the group

​
Request Example

PUT https://{instance}.domo.com/api/content/v2/groups/{group}/user/{userId}
Headers:
  X-DOMO-Developer-Token: <token>
  Content-Type: application/json

​
Response Example

Status Code: 200 
true

​
Remove a Person from a Group

​
Overview

Remove a user from a specific group.

Playground

​
Endpoint

DELETE /api/content/v2/groups/{group}/removeuser/{userId}

​
Path Parameters

ParameterTypeRequiredDescription
groupStringYesThe ID of the group
userIdStringYesThe ID of the user to remove

​
Request Example

DELETE https://{instance}.domo.com/api/content/v2/groups/{group}/removeuser/{userId}
Headers:
  X-DOMO-Developer-Token: <token>
  Content-Type: application/json

​
Response Example

Status Code: 200 
true

​
Remove Multiple People from a Group

​
Overview

Remove multiple users from a specific group.

Playground

​
Endpoint

PUT /api/content/v2/groups/access

​
Body Parameters

ParameterTypeRequiredDescription
groupIdStringYesThe ID of the group
removeMembersArrayYesList of members to remove, with type and id

​
Request Example

PUT https://{instance}.domo.com/api/content/v2/groups/access
Headers:
  X-DOMO-Developer-Token: <token>
  Content-Type: application/json
body:
[
  {
    "groupId": "1231231232",
    "removeMembers": [
      {
        "type": "USER",
        "id": "112321221"
      }
    ]
  }
]

​
Response Example

Status Code: 200 
true