Get a group

Gets information for a user group.

GET https://www.canva.com/_scim/v2/Groups/{canva_scim_id}
#Authorizationstring
Required

Provides credentials to authenticate the request, in the form of a Bearer token.

For example: Authorization: Bearer {token}

#canva_scim_idstring
Required

The Canva-generated SCIM ID for the group.

Examples for using the /_scim/v2/Groups/{canva_scim_id} endpoint:

curl --request GET 'https://www.canva.com/_scim/v2/Groups/{canva_scim_id}' \
--header 'Authorization: Bearer {token}'
sh

If successful, the endpoint returns a 200 response with a JSON body with the following parameters:

#schemasstring[]

The value for this can only be urn:ietf:params:scim:schemas:core:2.0:Group.

#idstring

The Canva-generated SCIM ID for the group.

#metaobject

Meta properties for the group.

Properties of meta
#resourceTypestring

The SCIM resource type of the object. The value for this can only be Group.

#createdstring

The timestamp when the object was created.

#displayNamestring

The name of the group, suitable for display to end-users.

#membersobject[]
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "UAFgrpb1abC",
"meta": {
"resourceType": "Group",
"created": "2023-09-18T06:08:35Z"
},
"displayName": "White rabbits",
"members": []
}
json
#schemasstring[]

The value for this can only be urn:ietf:params:scim:api:messages:2.0:Error.

#detailstring

The value for this can only be group {canva_scim_id} not found.

#statusstring

The HTTP status code of the error.

{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"detail": "group {canva_scim_id} not found",
"status": "404"
}
json