User Registrations

get

Authorizations

Path parameters

idintegerRequired

Query parameters

idintegerOptional

Canvas user ID

Responses

get

HTTPcURLJavaScriptPython

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": 43,
      "name": "Domain Account 51"
    },
    "name": "User 1",
    "email": "[e-mail]",
    "custom_fields": {
      "favorite_color": "#BADA55",
      "code_of_conduct": "1",
      "age": "19"
    },
    "created_at": "2025/03/28 13:11:24 +0000",
    "updated_at": "2025/03/28 13:11:24 +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

Responseobject

get

HTTPcURLJavaScriptPython

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": 44,
        "name": "Domain Account 52"
      },
      "name": "User 2",
      "email": "[e-mail]",
      "custom_fields": {
        "favorite_color": "#BADA55",
        "code_of_conduct": "1",
        "age": "19"
      },
      "created_at": "2025/03/28 13:11:24 +0000",
      "updated_at": "2025/03/28 13:11:24 +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

post

HTTPcURLJavaScriptPython

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": 45,
      "name": "Domain Account 53"
    },
    "name": "Barack Obama",
    "email": "[e-mail]",
    "custom_fields": {},
    "created_at": "2025/03/28 13:11:24 +0000",
    "updated_at": "2025/03/28 13:11:24 +0000"
  }
}