Get a group
Gets information for a user group.
HTTP method and URL path
GET
https://www.canva.com /_scim /v2 /Groups/{canva_scim_id}
Header parameters
Path parameters
Required
The Canva-generated SCIM ID for the group.
Example request
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
Success response
If successful, the endpoint returns a 200
response with a JSON body with the following parameters:
The value for this can only be urn:ietf:params:scim:schemas:core:2.0:Group
.
The Canva-generated SCIM ID for the group.
The name of the group, suitable for display to end-users.
Example response
{"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
Error responses
404 Not found
The value for this can only be urn:ietf:params:scim:api:messages:2.0:Error
.
The value for this can only be group {canva_scim_id} not found
.
The HTTP status code of the error.
Example error response
{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"detail": "group {canva_scim_id} not found","status": "404"}
json