Search groups

Searches for groups on Mindtickle by group name or by group ID.

View as Markdown

Prerequisites

Authentication and setup: A valid access token.

Endpoint

POST /services/data/v2.0/mtobjects/Groups

Base URL: the standard REST host for your region. See Base URLs.

Headers: Authorization: Bearer ACCESS_TOKEN, Content-Type: application/json.

Request

Parameter	Type	Required	Description
`names`	Array[string]	Optional	Names of the groups you want to search. Send each name as a separate string in the JSON array.
`ids`	Array[string]	Optional	Mindtickle IDs of the groups you want to search. Send each ID as a separate string in the JSON array.

Request example

{
  "names": ["APAC Sales", "EMEA SALES"],
  "ids": ["1234567890123456101", "1234567890123456102"]
}

Response

Field	Type	Description
`requestId`	string or null	Request identifier. The response examples return `null`.
`responseCode`	integer	Special response codes from the server.
`responseType`	string	Type of response from the server.
`taskCompleted`	boolean	Completion flag for this request. This endpoint returns its result directly.
`totalSize`	integer	Total number of groups returned in the response.
`groups`	Array[Group]	Information on the groups you have searched.
`groups[].name`	string	Name of the group.
`groups[].id`	string	Mindtickle ID of the group.

Response example

{
  "requestId": null,
  "responseCode": 0,
  "responseType": "GROUP_SEARCH_RESPONSE",
  "taskCompleted": true,
  "totalSize": 2,
  "groups": [
    {
      "name": "APAC Sales",
      "id": "1234567890123456102"
    },
    {
      "name": "EMEA SALES",
      "id": "1234567890123456101"
    }
  ]
}

Notes

Validation: The group names you enter must exactly match their name on the Mindtickle platform.