Group

This document uses the REST API. For more details, see the Authentication for API page.

Get Group (Early Access)

get

Get a group

Required permissions

• View Groups (group.read)

Authorizations

APITokenBearerAuth

Path parameters

group_idstring · uuidRequired

Unique identifier of the group.

Example: 00000000-0000-0000-0000-000000000000

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

200

Returns an instance of a Group

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

409

Conflict: The requested operation conflicts with the current state of the resource in some way.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

HTTPcURLJavaScriptPython

GET /rest/groups/{group_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "name": "My Group"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "relationships": {
      "tenant": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      }
    },
    "type": "group"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}