The Northpass API is organized around REST and JSON-API. JSON is returned by all API responses, including errors.
To use your API key, append to any API request.
GET https://api.northpass.com/v1/courses?api_key=API_KEY
All API requests must be made over HTTPS. API requests without authentication will also fail.
Northpass uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided. Northpass will follow the JSON-API error spec when encountering an error.
An example error response is as follows:
Status
422
{
"errors": [
{
"status": "422",
"title": "Invalid Attribute",
"detail": "Uh oh, that name has already been added",
"source": {
"pointer": "/data/attributes/name"
}
}
]
}
All top-level API resources have support for bulk fetches via "list" API methods. For instance you can list people, courses, and groups.
These list API methods share a common structure, taking at least these two parameters: page
and limit
.
Northpass utilizes offset-based pagination via the page and limit parameters.
To use pagination, append to any "list" API request.
GET https://api.northpass.com/v1/courses?page=2&limit=10
Pagination links appear in the links object that corresponds to a collection, as described by JSON-API. Pagination keys will be omitted to indicate that a particular link is unavailable.
An example of pagination links included in the returned JSON is as follows:
{
"links": {
"self": "https://api.northpass.com/v1/courses?page=2",
"prev": "https://api.northpass.com/v1/courses",
"next": "https://api.northpass.com/v1/courses?page=3"
}
}
Any index/listing endpoint will allow filtering of the results. All filtering is done by using the filter
query param. Any attribute that is returned in the result for a resource should be able to be used for filtering (eq uuid
, or anything listed under attributes).
For brevity, all the examples do not use the full url, but it should be added back when using.
people?filter[name]=foo
should be expanded to
https://api.northpass.com/v2/people?filter[name]=foo
Some examples are shown with no trailing []
and examples with a trailing []
. The trailing []
is required when providing a list of values (eg see IN usage). When only providing one value, the trailing []
can be used or not, either is supported.
For example, the following are identical:
people?filter[email][eq]=foo@example.com
people?filter[email][eq][]=foo@example.com
Attribute must match value exactly
people?filter[email][eq]=foo@example.com
Attribute must contain the provided value
people?filter[email][cont]=example.com
Attribute must match one of the requested values exactly
people?filter[email][in][]=foo@example.com&filter[email][in][]=bar@example.com
Compare attribute using provided predicate
groups?filter[membership_count][gteq][]=1
Available predicates: lteq
, gteq
, lt
, gt
For more complex filtering, you may need and or or combinators.
Example, filtering all groups with (membershipcount > 2 and name contains "Admin") or membershipcount = 0
groups?filter[and][or][membership_count][gt]=2&filter[and][or][name][cont]=Admin&filter[and][membership_count][eq]=0
Returns a list of activities for a specific course. The activities are returned in sorted order, alphabetically, by activity title.
GET /v2/courses/:course_id/activities
Name | Description |
---|---|
page
|
Page to view |
limit
|
Activities per page |
q
|
Query term, filters by activity title |
GET https://api.northpass.com/v2/courses/ea210647-aa59-49c1-85d1-5cae0ea6eed0/activities
200
{
"links": {
"self": "https://api.northpass.com/v2/courses/ea210647-aa59-49c1-85d1-5cae0ea6eed0/activities"
},
"data": [
{
"type": "activities",
"id": "b21fe6b7-8f2b-40e8-a058-f00f1a53e2b5",
"attributes": {
"title": "Welcome to SchoolKeep"
},
"links": {
"self": "https://api.northpass.com/v2/activities/b21fe6b7-8f2b-40e8-a058-f00f1a53e2b5"
}
},
{
"type": "activities",
"id": "95f17021-4a9b-4578-877c-0edb2f092097",
"attributes": {
"title": "How to build an effective course"
},
"links": {
"self": "https://api.northpass.com/v2/activities/95f17021-4a9b-4578-877c-0edb2f092097"
}
}
]
}
Returns a list of activities. The activities are returned in sorted order, alphabetically, by activity title.
GET /v2/activities
Name | Description |
---|---|
page
|
Page to view |
limit
|
Activities per page |
q
|
Query term, filters by activity title |
GET https://api.northpass.com/v2/activities
200
{
"links": {
"self": "https://api.northpass.com/v2/activities"
},
"data": [
{
"type": "activities",
"id": "a5537258-0873-4da3-98c2-805d7d31a23d",
"attributes": {
"title": "Optimal price point"
},
"links": {
"self": "https://api.northpass.com/v2/activities/a5537258-0873-4da3-98c2-805d7d31a23d"
}
},
{
"type": "activities",
"id": "b21fe6b7-8f2b-40e8-a058-f00f1a53e2b5",
"attributes": {
"title": "Welcome to SchoolKeep"
},
"links": {
"self": "https://api.northpass.com/v2/activities/b21fe6b7-8f2b-40e8-a058-f00f1a53e2b5"
}
},
{
"type": "activities",
"id": "eb6be363-eef1-4235-aae1-46cf5851c6e5",
"attributes": {
"title": "Why design matters"
},
"links": {
"self": "https://api.northpass.com/v2/activities/eb6be363-eef1-4235-aae1-46cf5851c6e5"
}
},
{
"type": "activities",
"id": "95f17021-4a9b-4578-877c-0edb2f092097",
"attributes": {
"title": "How to build an effective course"
},
"links": {
"self": "https://api.northpass.com/v2/activities/95f17021-4a9b-4578-877c-0edb2f092097"
}
}
]
}
Retrieves the details of an activity. You only need to supply the unique activity identifier.
GET /v2/activities/:id
Name | Description |
---|---|
id
Required
|
id |
GET https://api.northpass.com/v2/activities/b21fe6b7-8f2b-40e8-a058-f00f1a53e2b5
200
{
"data": {
"type": "activities",
"id": "b21fe6b7-8f2b-40e8-a058-f00f1a53e2b5",
"attributes": {
"title": "Welcome to SchoolKeep"
},
"links": {
"self": "https://api.northpass.com/v2/activities/b21fe6b7-8f2b-40e8-a058-f00f1a53e2b5"
}
}
}
Returns a list of assignment submissions for a specific assignment. The assignment submissions are returned in sorted order, with the most recently submitted assignment submissions appearing first.
GET /v2/assignments/:assignment_uuid/submissions
Name | Description |
---|---|
page
|
Page to view |
limit
|
Assignment submissions per page |
q
|
Query term, filters by assignment submissions name |
GET https://api.northpass.com/v2/assignments/277f4d79-72eb-4c5c-9f40-25b6e94ca49a/submissions
200
{
"links": {
"self": "https://api.northpass.com/v2/assignments/277f4d79-72eb-4c5c-9f40-25b6e94ca49a/submissions"
},
"data": [
{
"type": "assignment_submissions",
"id": "1a75f5ad-890a-4f24-9d1f-0e4ff135b7fb",
"attributes": {
"created_at": "2016-01-02T03:04:05Z"
},
"relationships": {
"assignment": {
"data": {
"type": "assignments",
"id": "277f4d79-72eb-4c5c-9f40-25b6e94ca49a"
}
},
"course": {
"data": {
"type": "courses",
"id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
}
},
"person": {
"data": {
"type": "people",
"id": "0a5318a7-72fc-488b-af0f-7b82991dabbe"
}
},
"course_attempt": {
"data": {
"type": "course_attempts",
"id": "f4f3b20a-eb90-4b3c-a8c2-942b49712982"
}
},
"groups": {
"data": [
]
}
},
"links": {
"self": "https://api.northpass.com/v2/submissions/1a75f5ad-890a-4f24-9d1f-0e4ff135b7fb",
"download": "https://cdn.filestackcontent.com/security=policy:eyJjYWxsIjpbInJlYWQiLCJjb252ZXJ0Iiwic3RvcmUiLCJwaWNrIl0sImV4cGlyeSI6MTU3MDY0MzkxOH0=,signature:0b5c45faacb026ba89346c490c286da3d7f0a09038d479a335acc4c5e9f6efa2/assignment.pdf"
}
},
{
"type": "assignment_submissions",
"id": "22e71d93-6f57-4b8d-b5fb-b2010d1ccce8",
"attributes": {
"created_at": "2016-01-02T03:04:05Z"
},
"relationships": {
"assignment": {
"data": {
"type": "assignments",
"id": "277f4d79-72eb-4c5c-9f40-25b6e94ca49a"
}
},
"course": {
"data": {
"type": "courses",
"id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
}
},
"person": {
"data": {
"type": "people",
"id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
}
},
"course_attempt": {
"data": {
"type": "course_attempts",
"id": "e000dc08-97a7-43e6-b231-1a4575aea8ed"
}
},
"groups": {
"data": [
]
}
},
"links": {
"self": "https://api.northpass.com/v2/submissions/22e71d93-6f57-4b8d-b5fb-b2010d1ccce8",
"download": "https://cdn.filestackcontent.com/security=policy:eyJjYWxsIjpbInJlYWQiLCJjb252ZXJ0Iiwic3RvcmUiLCJwaWNrIl0sImV4cGlyeSI6MTU3MDY0MzkxOH0=,signature:0b5c45faacb026ba89346c490c286da3d7f0a09038d479a335acc4c5e9f6efa2/assignment.pdf"
}
}
]
}
Returns a list of assignment submissions for all assignments. The assignment submissions are returned in sorted order, with the most recently submitted assignment submissions appearing first.
GET /v2/submissions
Name | Description |
---|---|
page
|
Page to view |
limit
|
Assignment submissions per page |
q
|
Query term, filters by assignment submissions name |
GET https://api.northpass.com/v2/submissions
200
{
"links": {
"self": "https://api.northpass.com/v2/submissions"
},
"data": [
{
"type": "assignment_submissions",
"id": "270c5a53-c033-459f-8801-b08787f1e5d0",
"attributes": {
"created_at": "2016-01-02T03:04:05Z"
},
"relationships": {
"assignment": {
"data": {
"type": "assignments",
"id": "0a932514-57b1-4d05-927e-47878a842fe2"
}
},
"course": {
"data": {
"type": "courses",
"id": "b685091b-6f65-4c20-9ba8-132b5ffbddde"
}
},
"person": {
"data": {
"type": "people",
"id": "0a5318a7-72fc-488b-af0f-7b82991dabbe"
}
},
"course_attempt": {
"data": {
"type": "course_attempts",
"id": "ee5c12ab-77ce-41f3-8db9-753fa7bfae60"
}
},
"groups": {
"data": [
]
}
},
"links": {
"self": "https://api.northpass.com/v2/submissions/270c5a53-c033-459f-8801-b08787f1e5d0",
"download": "https://cdn.filestackcontent.com/security=policy:eyJjYWxsIjpbInJlYWQiLCJjb252ZXJ0Iiwic3RvcmUiLCJwaWNrIl0sImV4cGlyeSI6MTU3MDY0MzkxOX0=,signature:004c92f6df644a2adb406724ec6d2cc1e2c3aa0b815c303f1bfa84a8c51c7dcf/assignment.pdf"
}
},
{
"type": "assignment_submissions",
"id": "1a75f5ad-890a-4f24-9d1f-0e4ff135b7fb",
"attributes": {
"created_at": "2016-01-02T03:04:05Z"
},
"relationships": {
"assignment": {
"data": {
"type": "assignments",
"id": "277f4d79-72eb-4c5c-9f40-25b6e94ca49a"
}
},
"course": {
"data": {
"type": "courses",
"id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
}
},
"person": {
"data": {
"type": "people",
"id": "0a5318a7-72fc-488b-af0f-7b82991dabbe"
}
},
"course_attempt": {
"data": {
"type": "course_attempts",
"id": "f4f3b20a-eb90-4b3c-a8c2-942b49712982"
}
},
"groups": {
"data": [
]
}
},
"links": {
"self": "https://api.northpass.com/v2/submissions/1a75f5ad-890a-4f24-9d1f-0e4ff135b7fb",
"download": "https://cdn.filestackcontent.com/security=policy:eyJjYWxsIjpbInJlYWQiLCJjb252ZXJ0Iiwic3RvcmUiLCJwaWNrIl0sImV4cGlyeSI6MTU3MDY0MzkxOX0=,signature:004c92f6df644a2adb406724ec6d2cc1e2c3aa0b815c303f1bfa84a8c51c7dcf/assignment.pdf"
}
},
{
"type": "assignment_submissions",
"id": "22e71d93-6f57-4b8d-b5fb-b2010d1ccce8",
"attributes": {
"created_at": "2016-01-02T03:04:05Z"
},
"relationships": {
"assignment": {
"data": {
"type": "assignments",
"id": "277f4d79-72eb-4c5c-9f40-25b6e94ca49a"
}
},
"course": {
"data": {
"type": "courses",
"id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
}
},
"person": {
"data": {
"type": "people",
"id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
}
},
"course_attempt": {
"data": {
"type": "course_attempts",
"id": "e000dc08-97a7-43e6-b231-1a4575aea8ed"
}
},
"groups": {
"data": [
]
}
},
"links": {
"self": "https://api.northpass.com/v2/submissions/22e71d93-6f57-4b8d-b5fb-b2010d1ccce8",
"download": "https://cdn.filestackcontent.com/security=policy:eyJjYWxsIjpbInJlYWQiLCJjb252ZXJ0Iiwic3RvcmUiLCJwaWNrIl0sImV4cGlyeSI6MTU3MDY0MzkxOX0=,signature:004c92f6df644a2adb406724ec6d2cc1e2c3aa0b815c303f1bfa84a8c51c7dcf/assignment.pdf"
}
}
]
}
It takes an array of people uuids and enrolls them to a course
POST /v2/bulk/enrollments
Name | Description | type |
---|---|---|
course_uuids
Required
|
Courses uuids | array |
person_uuids
Required
|
Person uuids | array |
POST https://api.northpass.com/v2/bulk/enrollments
{
"course_uuids": [
"3c2e9960-4241-4a70-9a49-397f1b56205a"
],
"person_uuids": [
"8ed2d73f-7b91-4720-839b-5127a8a26334",
"17d1d4e7-be10-479e-b1b7-d365bc12274c"
]
}
202
Returns a list of courses. The courses are returned in sorted order, alphabetically, by course name.
GET /v2/courses
Name | Description |
---|---|
page
|
Page to view |
limit
|
Courses per page |
q
|
Query term, filters by course name |
GET https://api.northpass.com/v2/courses
200
{
"links": {
"self": "https://api.northpass.com/v2/courses"
},
"data": [
{
"type": "courses",
"id": "b685091b-6f65-4c20-9ba8-132b5ffbddde",
"attributes": {
"name": "Design and Market Your School Site",
"enrollments_count": 0,
"permalink": "qjcud6ho",
"created_at": "2016-01-02T03:04:05Z",
"updated_at": "2016-02-03T04:05:06Z",
"status": "live"
},
"relationships": {
"instructor_partnerships": {
"data": [
]
}
},
"links": {
"self": {
"href": "https://api.northpass.com/v2/courses/b685091b-6f65-4c20-9ba8-132b5ffbddde",
"meta": {
"methods": [
"get",
"post",
"put",
"delete"
]
}
},
"builder": {
"href": "https://app.northpass.com/courses/qjcud6ho/builder",
"meta": {
"methods": [
"get"
]
}
},
"edit": {
"href": "https://app.northpass.com/courses/qjcud6ho/edit",
"meta": {
"methods": [
"get"
]
}
},
"archive": {
"href": "https://api.northpass.com/v2/courses/b685091b-6f65-4c20-9ba8-132b5ffbddde",
"meta": {
"methods": [
"put"
],
"data": {
"data": {
"attributes": {
"status": "archived"
}
}
}
}
},
"unarchive": {
"href": "https://api.northpass.com/v2/courses/b685091b-6f65-4c20-9ba8-132b5ffbddde",
"meta": {
"methods": [
],
"data": {
"data": {
"attributes": {
"status": "live"
}
}
}
}
},
"clone": {
"href": "https://app.northpass.com/courses/qjcud6ho/clone",
"meta": {
"methods": [
"post"
]
}
},
"preview": {
"href": "https://app.northpass.com/previews/courses/qjcud6ho",
"meta": {
"methods": [
"get"
]
}
},
"enroll": {
"href": "http://academy.northpass.com/c/e7d9d8c3f9d3c4fa81201b547ff8f578ae8e9856",
"meta": {
"methods": [
"get"
]
}
}
}
},
{
"type": "courses",
"id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0",
"attributes": {
"name": "SchoolKeep Onboarding",
"enrollments_count": 0,
"permalink": "f24cj7q3",
"created_at": "2016-01-02T03:04:05Z",
"updated_at": "2016-02-03T04:05:06Z",
"status": "live"
},
"relationships": {
"instructor_partnerships": {
"data": [
]
}
},
"links": {
"self": {
"href": "https://api.northpass.com/v2/courses/ea210647-aa59-49c1-85d1-5cae0ea6eed0",
"meta": {
"methods": [
"get",
"post",
"put",
"delete"
]
}
},
"builder": {
"href": "https://app.northpass.com/courses/f24cj7q3/builder",
"meta": {
"methods": [
"get"
]
}
},
"edit": {
"href": "https://app.northpass.com/courses/f24cj7q3/edit",
"meta": {
"methods": [
"get"
]
}
},
"archive": {
"href": "https://api.northpass.com/v2/courses/ea210647-aa59-49c1-85d1-5cae0ea6eed0",
"meta": {
"methods": [
"put"
],
"data": {
"data": {
"attributes": {
"status": "archived"
}
}
}
}
},
"unarchive": {
"href": "https://api.northpass.com/v2/courses/ea210647-aa59-49c1-85d1-5cae0ea6eed0",
"meta": {
"methods": [
],
"data": {
"data": {
"attributes": {
"status": "live"
}
}
}
}
},
"clone": {
"href": "https://app.northpass.com/courses/f24cj7q3/clone",
"meta": {
"methods": [
"post"
]
}
},
"preview": {
"href": "https://app.northpass.com/previews/courses/f24cj7q3",
"meta": {
"methods": [
"get"
]
}
},
"enroll": {
"href": "http://academy.northpass.com/c/4a7c9d2142e67018bfe7bfa7d7552f44c0756837",
"meta": {
"methods": [
"get"
]
}
}
}
},
{
"type": "courses",
"id": "ae84c10c-31d4-4c16-bf25-9c37ecbc6632",
"attributes": {
"name": "Sell Content with the Commerce Tool",
"enrollments_count": 0,
"permalink": "s3p9kahv",
"created_at": "2016-01-02T03:04:05Z",
"updated_at": "2016-02-03T04:05:06Z",
"status": "live"
},
"relationships": {
"instructor_partnerships": {
"data": [
]
}
},
"links": {
"self": {
"href": "https://api.northpass.com/v2/courses/ae84c10c-31d4-4c16-bf25-9c37ecbc6632",
"meta": {
"methods": [
"get",
"post",
"put",
"delete"
]
}
},
"builder": {
"href": "https://app.northpass.com/courses/s3p9kahv/builder",
"meta": {
"methods": [
"get"
]
}
},
"edit": {
"href": "https://app.northpass.com/courses/s3p9kahv/edit",
"meta": {
"methods": [
"get"
]
}
},
"archive": {
"href": "https://api.northpass.com/v2/courses/ae84c10c-31d4-4c16-bf25-9c37ecbc6632",
"meta": {
"methods": [
"put"
],
"data": {
"data": {
"attributes": {
"status": "archived"
}
}
}
}
},
"unarchive": {
"href": "https://api.northpass.com/v2/courses/ae84c10c-31d4-4c16-bf25-9c37ecbc6632",
"meta": {
"methods": [
],
"data": {
"data": {
"attributes": {
"status": "live"
}
}
}
}
},
"clone": {
"href": "https://app.northpass.com/courses/s3p9kahv/clone",
"meta": {
"methods": [
"post"
]
}
},
"preview": {
"href": "https://app.northpass.com/previews/courses/s3p9kahv",
"meta": {
"methods": [
"get"
]
}
},
"enroll": {
"href": "http://academy.northpass.com/c/f80f6eeb322feab5003e5ed70fc4f35b9b681b4f",
"meta": {
"methods": [
"get"
]
}
}
}
}
],
"included": [
]
}
Returns a list of events. The events are returned in sorted order, chronologically, by creation date.
GET /v2/events
Name | Description |
---|---|
page
|
Page to view |
limit
|
Events per page |
GET https://api.northpass.com/v2/events
200
{
"links": {
"self": "https://api.northpass.com/v2/events"
},
"data": [
{
"type": "learner_viewed_activity_events",
"attributes": {
"created_at": "2016-01-02T03:04:05Z"
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "0a5318a7-72fc-488b-af0f-7b82991dabbe"
}
},
"activity": {
"data": {
"type": "activities",
"id": "b21fe6b7-8f2b-40e8-a058-f00f1a53e2b5"
}
}
}
},
{
"type": "learner_viewed_video_activity_events",
"attributes": {
"created_at": "2016-01-02T03:04:05Z",
"percentage_watched": 0.5
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
}
},
"activity": {
"data": {
"type": "activities",
"id": "95f17021-4a9b-4578-877c-0edb2f092097"
}
},
"course_attempt": {
"data": {
"type": "course_attempts",
"id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
}
}
}
}
]
}
Deactivates a learner
POST /v2/people/:person_uuid/deactivations
Name | Description |
---|---|
person_uuid
Required
|
Person's uuid |
POST https://api.northpass.com/v2/people/576dd317-372a-4173-837b-ea1dc7a55837/deactivations
204
Reactivates a learner
DELETE /v2/people/:person_uuid/deactivations
Name | Description |
---|---|
person_uuid
Required
|
Person's uuid |
DELETE https://api.northpass.com/v2/people/8c55da71-fa34-4bae-912b-2cae996b74e1/deactivations
204
Returns a list of people. The people are returned in sorted order, alphabetically, by full name.
GET /v2/people
Name | Description |
---|---|
page
|
Page to view |
limit
|
People per page |
q
|
Query term, filters by people name |
GET https://api.northpass.com/v2/people
200
{
"links": {
"self": "https://api.northpass.com/v2/people"
},
"data": [
{
"type": "people",
"id": "dba33949-18d3-4f7d-83ee-8de8c1370b31",
"attributes": {
"activated_at": "2016-02-03T05:00:00.000Z",
"created_at": "2016-01-02T03:04:05Z",
"custom_avatar_url": "https://secure.gravatar.com/avatar/de6fbb2be0a7ebf867a1ec4eb2f99006?d=identicon&s=200",
"disabled": false,
"email": "api+einstein@schoolkeep.com",
"first_name": "Albert",
"full_name": "Albert Einstein",
"last_active_at": "2016-02-03T04:05:04Z",
"last_name": "Einstein",
"name": "Albert Einstein",
"registration_status": "activated",
"unsubscribed": false,
"updated_at": "2019-10-09T13:58:40Z"
},
"links": {
"self": {
"href": "https://api.northpass.com/v2/people/dba33949-18d3-4f7d-83ee-8de8c1370b31",
"methods": [
"get",
"delete"
]
},
"teaching": {
"href": "https://app.northpass.com/people/dba33949-18d3-4f7d-83ee-8de8c1370b31",
"methods": [
"get",
"patch"
]
}
},
"relationships": {
"partnerships": {
"data": [
{
"type": "partnerships",
"id": "5914811c-b4c5-4ac4-9e6d-294c3b77d024"
},
{
"type": "partnerships",
"id": "04aca00c-57f4-4b5f-abc7-cdb587683b9b"
}
]
},
"school": {
"data": {
"type": "schools",
"id": "5f72a658-292b-4cc1-8507-0f1c5b820427"
}
}
}
},
{
"type": "people",
"id": "0a5318a7-72fc-488b-af0f-7b82991dabbe",
"attributes": {
"activated_at": "2016-02-03T05:00:00.000Z",
"created_at": "2016-01-02T03:04:05Z",
"custom_avatar_url": "https://secure.gravatar.com/avatar/df68aaf51c6ecfe57a650448aca0b28e?d=identicon&s=200",
"disabled": false,
"email": "api+curie@schoolkeep.com",
"first_name": "Marie",
"full_name": "Marie Curie",
"last_active_at": "2016-02-03T04:05:04Z",
"last_name": "Curie",
"name": "Marie Curie",
"registration_status": "activated",
"unsubscribed": false,
"updated_at": "2019-10-09T13:58:40Z"
},
"links": {
"self": {
"href": "https://api.northpass.com/v2/people/0a5318a7-72fc-488b-af0f-7b82991dabbe",
"methods": [
"get",
"delete"
]
},
"teaching": {
"href": "https://app.northpass.com/people/0a5318a7-72fc-488b-af0f-7b82991dabbe",
"methods": [
"get",
"patch"
]
}
},
"relationships": {
"partnerships": {
"data": [
{
"type": "partnerships",
"id": "8f7179ed-cfe6-45b5-9649-c4831e39a27f"
},
{
"type": "partnerships",
"id": "ad727cdf-d74e-4924-b0b7-73bfe7da2c00"
}
]
},
"school": {
"data": {
"type": "schools",
"id": "5f72a658-292b-4cc1-8507-0f1c5b820427"
}
}
}
},
{
"type": "people",
"id": "e598cb5b-d172-464b-93ec-0631fb491f1d",
"attributes": {
"activated_at": "2019-10-09T13:58:40.819Z",
"created_at": "2016-01-02T03:04:05Z",
"custom_avatar_url": "https://secure.gravatar.com/avatar/cd63fed8029dffbc7fecd5b79c876b48?d=identicon&s=200",
"disabled": false,
"email": "api+tesla@schoolkeep.com",
"first_name": "Nikola",
"full_name": "Nikola Tesla",
"last_name": "Tesla",
"name": "Nikola Tesla",
"registration_status": "activated",
"unsubscribed": false,
"updated_at": "2019-10-09T13:58:40Z"
},
"links": {
"self": {
"href": "https://api.northpass.com/v2/people/e598cb5b-d172-464b-93ec-0631fb491f1d",
"methods": [
"get"
]
},
"teaching": {
"href": "https://app.northpass.com/people/e598cb5b-d172-464b-93ec-0631fb491f1d",
"methods": [
"get",
"patch"
]
}
},
"relationships": {
"partnerships": {
"data": [
{
"type": "partnerships",
"id": "41cad80f-dafa-4b5a-861e-aab58278d096"
},
{
"type": "partnerships",
"id": "75eda749-a9d0-4b47-a07d-dba1e530d94c"
}
]
},
"school": {
"data": {
"type": "schools",
"id": "5f72a658-292b-4cc1-8507-0f1c5b820427"
}
}
}
}
]
}
Retrieves the details of a person. You only need to supply the unique person identifier.
GET /v2/people/:uuid
Name | Description |
---|---|
uuid
Required
|
Person's uuid |
GET https://api.northpass.com/v2/people/dba33949-18d3-4f7d-83ee-8de8c1370b31
200
{
"data": {
"type": "people",
"id": "dba33949-18d3-4f7d-83ee-8de8c1370b31",
"attributes": {
"activated_at": "2016-02-03T05:00:00.000Z",
"created_at": "2016-01-02T03:04:05Z",
"custom_avatar_url": "https://secure.gravatar.com/avatar/a6ae03cf6e2fcfa1ef7edd4e3ed43cea?d=identicon&s=200",
"disabled": false,
"email": "api+einstein@schoolkeep.com",
"first_name": "Albert",
"full_name": "Albert Einstein",
"last_active_at": "2016-02-03T04:05:04Z",
"last_name": "Einstein",
"name": "Albert Einstein",
"registration_status": "activated",
"unsubscribed": false,
"updated_at": "2019-10-09T13:58:41Z"
},
"links": {
"self": {
"href": "https://api.northpass.com/v2/people/dba33949-18d3-4f7d-83ee-8de8c1370b31",
"methods": [
"get",
"delete"
]
},
"teaching": {
"href": "https://app.northpass.com/people/dba33949-18d3-4f7d-83ee-8de8c1370b31",
"methods": [
"get",
"patch"
]
}
},
"relationships": {
"partnerships": {
"data": [
{
"type": "partnerships",
"id": "5914811c-b4c5-4ac4-9e6d-294c3b77d024"
},
{
"type": "partnerships",
"id": "04aca00c-57f4-4b5f-abc7-cdb587683b9b"
}
]
},
"school": {
"data": {
"type": "schools",
"id": "5f72a658-292b-4cc1-8507-0f1c5b820427"
}
}
}
}
}
Creates a new person, and sends an invite.
If your school is using URL Authentication, this request will be forbidden.
POST /v2/people
Name | Description |
---|---|
data[type] Required | Data type |
data[attributes][email] Required | Data attributes email |
POST https://api.northpass.com/v2/people
{
"data": {
"type": "people",
"attributes": {
"email": "api+faraday@schoolkeep.com"
}
}
}
201
{
"data": {
"type": "people",
"id": "216e9db2-e25b-45c8-8b16-25ffa2eabad7",
"attributes": {
"created_at": "2016-02-03T04:05:06Z",
"custom_avatar_url": "https://secure.gravatar.com/avatar/b911de189e0e58093509f56c855021a2?d=identicon&s=200",
"disabled": false,
"email": "api+faraday@schoolkeep.com",
"registration_status": "not_activated",
"unsubscribed": false,
"updated_at": "2016-02-03T04:05:06Z"
},
"links": {
"self": {
"href": "https://api.northpass.com/v2/people/216e9db2-e25b-45c8-8b16-25ffa2eabad7",
"methods": [
"get",
"delete"
]
},
"teaching": {
"href": "https://app.northpass.com/people/216e9db2-e25b-45c8-8b16-25ffa2eabad7",
"methods": [
"get",
"patch"
]
},
"resend-invite": {
"href": "https://api.northpass.com/v1/people/216e9db2-e25b-45c8-8b16-25ffa2eabad7/resend-invite",
"methods": [
"post"
]
}
},
"relationships": {
"partnerships": {
"data": [
{
"type": "partnerships",
"id": "589d1379-5d7c-4f4b-8224-440a424ffdd5"
}
]
},
"school": {
"data": {
"type": "schools",
"id": "5f72a658-292b-4cc1-8507-0f1c5b820427"
}
}
}
}
}
Permanently deletes a person. It cannot be undone.
DELETE /v2/people/:uuid
Name | Description |
---|---|
uuid
Required
|
uuid |
DELETE https://api.northpass.com/v2/people/0a5318a7-72fc-488b-af0f-7b82991dabbe
204
Retakes a course with present course attempt
POST /v2/courses/:course_uuid/people/:person_uuid/retakes
POST https://api.northpass.com/v2/courses/6b59d234-93bb-40c5-b5b6-4f56eba419ec/people/03c005bc-4f99-40d0-92cd-0b48b6e4088d/retakes
202
{
"status": "accepted"
}