User Registrations
get
Authorizations
Path parameters
idintegerRequired
Query parameters
idintegerOptional
Canvas user ID
Responses
200
Getting a specific user registration
application/json
get
GET /api/v1/user_registrations/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Getting a specific user registration
{
"user_registration": {
"canvas_user_id": 1,
"catalog": {
"id": 2,
"name": "Domain Account 2"
},
"name": "User 1",
"email": "[email protected]",
"custom_fields": {
"favorite_color": "#BADA55",
"code_of_conduct": "1",
"age": "19"
},
"created_at": "2025/06/10 13:42:01 +0000",
"updated_at": "2025/06/10 13:42:01 +0000"
}
}
get
Authorizations
Query parameters
fromstringOptional
Earliest date/time to return (optional, String). Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.
tostringOptional
Latest date/time to return (optional, String). See 'from' above for format.
Responses
200
Listing user registrations
application/json
Responseobject
get
GET /api/v1/user_registrations HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Listing user registrations
{
"user_registrations": [
{
"canvas_user_id": 2,
"catalog": {
"id": 3,
"name": "Domain Account 3"
},
"name": "User 2",
"email": "[email protected]",
"custom_fields": {
"favorite_color": "#BADA55",
"code_of_conduct": "1",
"age": "19"
},
"created_at": "2025/06/10 13:42:01 +0000",
"updated_at": "2025/06/10 13:42:01 +0000"
}
]
}
post
Authorizations
Body
namestringOptional
Full name
emailstringOptional
E-mail address (will also serve as login)
catalog_idstringOptional
ID of subcatalog to associate with user (optional)
custom_fieldsstringOptional
Hash of custom field values, e.g. { 'phone': '867-5309' } (optional)
Responses
201
Registering a user
application/json
post
POST /api/v1/user_registrations HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 73
"name='text'&email='text'&catalog_id='text'&custom_fields='text'"
201
Registering a user
{
"user_registration": {
"canvas_user_id": 1234,
"catalog": {
"id": 4,
"name": "Domain Account 4"
},
"name": "Barack Obama",
"email": "[email protected]",
"custom_fields": {},
"created_at": "2025/06/10 13:42:01 +0000",
"updated_at": "2025/06/10 13:42:01 +0000"
}
}
Last updated
Was this helpful?