GOgomotive

View group details by name

get/v1/groups?name={group_name}

Request

Query parameters

namestring required

Specify the name of the group to view it's details such as ID, Parent ID, and User details.

Headers

X-API-KEYstring required

Specify the API key of the company for which you are retrieving the group information..

Response

200

Example response

{
  "groups": [
    {
      "group": {
        "id": 95436,
        "name": "PL_252 FARGO",
        "company_id": 329134,
        "parent_id": 95435,
        "user": {
          "id": 3748102,
          "first_name": "Dexter",
          "last_name": "Martins",
          "email": "dexter.martins@vestis.com",
          "status": "active",
          "role": "admin"
        }
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.