v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Users

List a User's Draft Registrations

Retrieves a list of draft registrations for the specified user. Only the authenticated user can view their own draft registrations.

Returns

Returns a JSON object with a data key containing an array of draft registration resources.

Errors

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes.

get/users/{user_id}/draft_registrations/

Path parameters

user_idstring required

The unique identifier of the user. Example: abc123

Query parameters

pageinteger

Page number of results to view (pagination). Default is 1.

filter[title]string

Filter draft registrations by title.

Response

Successfully retrieved the list of draft registrations.

Example response

{
  "data": [
    {
      "data": {
        "type": "users",
        "id": "{user_id}",
        "attributes": {
          "full_name": "Casey M. Rollins",
          "middle_names": "Marie",
          "social": {
            "github": [
              "https://github.com/caseyrollins"
            ],
            "twitter": [
              "https://twitter.com/crollins"
            ]
          },
          "employment": [
            {
              "title": "Data Scientist",
              "institution": "Open Science Framework",
              "department": "Engineering",
              "startYear": 2018,
              "startMonth": 5,
              "ongoing": true
            }
          ],
          "education": [
            {
              "degree": "MS in Computer Science",
              "institution": "University of Somewhere",
              "department": "Computer Science",
              "startYear": 2014,
              "startMonth": 9,
              "endYear": 2016,
              "endMonth": 6,
              "ongoing": false
            }
          ]
        }
      }
    }
  ]
}