Continu API
Welcome to the Continu API. You can use our API to get access to learner completion information contained within Continu.
Authentication
curl -X POST -H "Content-Type: application/json" -d '{"client_id": "<client_id>", "client_secret": "<client_secret>"}' https://usw2-api.continu.co/v3/oauth2/access-token
// Which will return:
{"access_token":"<token>","token_type":"bearer","expires_in":<epoch>}
Continu uses the OAuth 2.0 protocol's Client Credentials Flow for authentication and authorization. With these credentials, the client requests a bearer access token. This token is retrieved by POST'ing the following information:
Parameter | Description |
---|---|
client_id | The ID of the client supplied by us |
client_secret | The secret of the client supplied by us |
https://usw2-api.continu.co/v3/oauth2/access-token
The calling application extracts the access token from the response (see the example) and then sends the token using an HTTP authorization header with the value in the format Bearer
. Access tokens are valid only for the set of operations and resources described in the scope of the token request.
Rate Limit
We currently limit the number of calls a single client can make to 50 requests per minute. If you exceed the limit, we return a 429 Too Many Requests
response.
Every response from our API contains the following headers:
Header | Description |
---|---|
X-REQUESTS-PER-MINUTE | The number of requests counted last minute |
X-REQUESTS-PER-DAY | The number of requests today |
Authtokens
Authenticates user and returns access url
Code Sample
# You can also use wget
curl -X POST https://usw2-oapi.continu.co/api/v1/authtokens/oauth/access-url \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint returns an access token based on the key and identifier sent and updates a partially the User instance
Body parameter
{
"identifier": "345435345",
"identifier_type": "userid"
}
HTTP Request
POST https://usw2-oapi.continu.co/api/v1/authtokens/oauth/access-url
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.OAuthIdentifier | true | The OAuthIdentifier for the authentication process |
» identifier | body | string | false | none |
» identifier_type | body | string | false | none |
Example Response
200 Response
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |
Assessments
Get Assessments completion
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/completion/assessments \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Assessments for specific users. Users should be specified as a comma separated list of email addresses for which the Assessment information is required. You also have the option to specify a date range using the FROM or UNTIL Unix Epoch timestamp.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/completion/assessments
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
query | string | false | Comma Separated List of users for which to return the Assessment Completion List | |
external_id | query | string | false | UserId value expected (employee id, phone number, client defined id for users) |
locations | query | string | false | Location value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
departments | query | string | false | Department value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
teams | query | string | false | Team value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
levels | query | string | false | Level value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
grades | query | string | false | Grade value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
assessment | query | string | false | Comma Separated List of Assessment IDs for which to return the Assessment Completion List |
from | query | integer | false | From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
until | query | integer | false | Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
range_target | query | string | false | Date-Range target field (from & until). This value can be started_date or passed_date indicating to which date field should the date-range be applied to. The default value is started_date |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"assessments": [
{
"attempts": 1,
"completion_status": "Passed",
"grading_status": "Completed",
"id": "5b72efb05e8e1534c818ec81",
"passed_date": "2018-09-11T17:23:06.667Z",
"score": 100,
"started_date": "2018-09-06T17:07:20.942Z",
"title": "Designing for the Modern Workplace",
"type": "Video Coaching"
}
],
"email": "theresa@continu.co",
"external_id": "1234544",
"first_name": "Theresa",
"last_name": "Jenkins",
"user_id": "56b1258a9f176c1100e7e993"
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Assignments
Get Assignments completion
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/completion/assignments \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Assignments for specific users. Users should be specified as a comma separated list of email addresses for which the Assignment information is required. You also have the option to specify a date range using the FROM or UNTIL Unix Epoch timestamp.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/completion/assignments
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
query | string | false | Comma Separated List of users for which to return the AssignmentsList | |
external_id | query | string | false | UserId value expected (employee id, phone number, client defined id for users) |
locations | query | string | false | Location value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
departments | query | string | false | Department value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
teams | query | string | false | Team value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
levels | query | string | false | Level value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
grades | query | string | false | Grade value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
content | query | string | false | Comma Separated List of Content IDs for which to return the AssignmentsList |
from | query | integer | false | From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
until | query | integer | false | Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
range_target | query | string | false | Date-Range target field (from & until). This value can be assigned_date,updated_date, due_date, or completed_date indicating to which date field should the date-range be applied to. The default value is assigned_date |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"assignments": [
{
"assigned_content": [
{
"completed_date": "2019-09-04T14:24:16.393Z",
"content_id": "54e6411129b6698c270000d6",
"content_title": "Sales Enablement Track",
"content_type": "Track"
}
],
"assigned_date": "2019-09-01T14:24:16.393Z",
"assignment_id": "57bdd6624487471000e2bf3a",
"completed": true,
"completed_date": "2019-09-04T14:24:16.393Z",
"completion_status": "Completed - On Time",
"due_date": "2019-09-05T14:24:16.393Z"
}
],
"email": "stanleybond@continu.co",
"external_id": "12344",
"first_name": "Stanly",
"last_name": "Bond",
"user_id": "551b3553932def2b1e000019"
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Learning Tracks
Lists Learning Tracks Completion Information for all the user emails in the mandatory for_users argument
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/completion/tracks \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Learning Tracks for specific users. Users should be specified as a comma separated list of email addresses for which the Learning Track information is required. You also have the option to specify a date range using the from or until Unix Epoch timestamp.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/completion/tracks
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
query | string | false | Comma Separated List of users for which to return the Learning Tracks Completion List | |
external_id | query | string | false | UserId value expected (employee id, phone number, client defined id for users) |
locations | query | string | false | Location value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
departments | query | string | false | Department value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
teams | query | string | false | Team value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
levels | query | string | false | Level value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
grades | query | string | false | Grade value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
track | query | string | false | Comma Separated List of Track IDs for which to return the Learning Tracks Completion List |
from | query | integer | false | From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
until | query | integer | false | Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
range_target | query | string | false | Date-Range target field (from & until). This value can be started_date or completed_date indicating to which date field should the date-range be apply to. The default value is started_date |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"email": "ferdinand@continu.co",
"external_id": "12344",
"first_name": "Ferdinand",
"last_name": "Danton",
"tracks": [
{
"completed": true,
"completed_date": "2019-07-19T15:32:53.744Z",
"duration": 5,
"id": "5d6fea50ca2bc5000fdf7dd6",
"name": "Sales Tools for Teams",
"progress": 100,
"started_date": "2019-07-19T15:16:54.744Z"
}
],
"user_id": "5aa15c20f070380bcd59214c"
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Workshops
Get Workshops completion
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/completion/workshops \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Workshops for specific users. Users should be specified as a comma separated list of email addresses for which the Workshop information is required. You also have the option to specify a date range using the from or until Unix Epoch timestamp.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/completion/workshops
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
query | string | false | Comma Separated List of users for which to return the Workshops Completion List | |
external_id | query | string | false | UserId value expected (employee id, phone number, client defined id for users) |
locations | query | string | false | Location value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
departments | query | string | false | Department value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
teams | query | string | false | Team value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
levels | query | string | false | Level value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
grades | query | string | false | Grade value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
workshop | query | string | false | Comma Separated List of Workshop IDs for which to return the Workshops Completion List |
from | query | integer | false | From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
until | query | integer | false | Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
range_target | query | string | false | Date-Range target field (from & until). This value can be created_date,started_date, or end_date indicating to which date field should the date-range be apply to. The default value is started_date |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"email": "mark@continu.co",
"external_id": "5aa15c20f070380bcd59214c",
"first_name": "Mark",
"last_name": "Schumacher",
"user_id": "5aa15c20f070380bcd59214c",
"workshops": [
{
"date": "2020-04-28T09:13:30.466Z",
"facilitator": "Ferdinand Danton",
"id": "5aa15c20f070380bcd59214c",
"status": "attended",
"title": "Full Zoom Workshop"
}
]
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Departments
Get Department List
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/departments \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Department's briefs, you may return them as a list size of 50 records, 100, or 500, and in a "compact", "summary", or "full" list type. If omitted, the default values for the list are "compact" and 50 records. If you want to return the next batch of 50, 100, or 500 records The list To get the next group of records send id_from argument with the last id you received.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/departments
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id_from | query | string | false | Optional Id from the last record previously returned. This will be the Id from which data is returned |
list_size | query | string | false | Size of the returned list. This value can be 50, 100, or 500 |
list_type | query | string | false | Type of List to return. This value can be compact, summary, or full indicating the number of fields included in each element returned |
name | query | string | false | Name value expected or comma separated list of values (Marketing, Engineering, Human Resources) |
created_at_from | query | integer | false | CreatedAt From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
created_at_until | query | integer | false | CreatedAt Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"children": [
"56b9938a9f176c1100e7e125"
],
"company": "56b1258a9f176c1100e7e993",
"id": "56b1258a9f176c1100e7e993",
"level": 1,
"localized_names": "fr:featured-fr,de:gerfeatured,pt_br:Novidades,es_la:Spanish Featured,deu:Neuigkeiten",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Creates a Department
Code Sample
# You can also use wget
curl -X POST https://usw2-oapi.continu.co/api/v1/data/departments \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint creates a Department instance
Body parameter
{
"level": 1,
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
POST https://usw2-oapi.continu.co/api/v1/data/departments
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationInsert | true | The Department to create |
» level | body | integer | false | none |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
201 Response
Responses
Status | Meaning | Description |
---|---|---|
201 | Created | Created |
400 | Bad Request | Bad Request |
409 | Conflict | Conflict |
500 | Internal Server Error | Internal Server Error |
Get Department by id
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/departments/{id} \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint gets the department corresponding to the given id.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/departments/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the department requested. |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Update a Department
Code Sample
# You can also use wget
curl -X PATCH https://usw2-oapi.continu.co/api/v1/data/departments/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint replaces/updates a whole Department instance
Body parameter
{
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
PATCH https://usw2-oapi.continu.co/api/v1/data/departments/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the Department requested to be replaced. |
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationUpdate | true | The Department to replace |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
400 Response
Responses
Status | Meaning | Description |
---|---|---|
204 | No Content | none |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |
Grades
Get Grade List
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/grades \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Grade's briefs, you may return them as a list size of 50 records, 100, or 500, and in a "compact", "summary", or "full" list type. If omitted, the default values for the list are "compact" and 50 records. If you want to return the next batch of 50, 100, or 500 records The list To get the next group of records send id_from argument with the last id you received.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/grades
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id_from | query | string | false | Optional Id from the last record previously returned. This will be the Id from which data is returned |
list_size | query | string | false | Size of the returned list. This value can be 50, 100, or 500 |
list_type | query | string | false | Type of List to return. This value can be compact, summary, or full indicating the number of fields included in each element returned |
name | query | string | false | Name value expected or comma separated list of values (A+, A, B+, 1, 5, 10) |
created_at_from | query | integer | false | CreatedAt From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
created_at_until | query | integer | false | CreatedAt Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"children": [
"56b9938a9f176c1100e7e125"
],
"company": "56b1258a9f176c1100e7e993",
"id": "56b1258a9f176c1100e7e993",
"level": 1,
"localized_names": "fr:featured-fr,de:gerfeatured,pt_br:Novidades,es_la:Spanish Featured,deu:Neuigkeiten",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Creates a Grade
Code Sample
# You can also use wget
curl -X POST https://usw2-oapi.continu.co/api/v1/data/grades \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint creates a Grade instance
Body parameter
{
"level": 1,
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
POST https://usw2-oapi.continu.co/api/v1/data/grades
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationInsert | true | The Grade to create |
» level | body | integer | false | none |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
201 Response
Responses
Status | Meaning | Description |
---|---|---|
201 | Created | Created |
400 | Bad Request | Bad Request |
409 | Conflict | Conflict |
500 | Internal Server Error | Internal Server Error |
Get Grade by id
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/grades/{id} \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint gets the grade corresponding to the given id.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/grades/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the grade requested. |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Update a Grade
Code Sample
# You can also use wget
curl -X PATCH https://usw2-oapi.continu.co/api/v1/data/grades/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint replaces/updates a whole Grade instance
Body parameter
{
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
PATCH https://usw2-oapi.continu.co/api/v1/data/grades/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the Grade requested to be replaced. |
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationUpdate | true | The Grade to replace |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
400 Response
Responses
Status | Meaning | Description |
---|---|---|
204 | No Content | none |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |
Groups
Get Group List
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/groups \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Group's briefs, you may return them as a list size of 50 records, 100, or 500, and in a "compact", "summary", or "full" list type. If omitted, the default values for the list are "compact" and 50 records. If you want to return the next batch of 50, 100, or 500 records The list To get the next group of records send id_from argument with the last id you received.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/groups
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id_from | query | string | false | Optional Id from the last record previously returned. This will be the Id from which data is returned |
list_size | query | string | false | Size of the returned list. This value can be 50, 100, or 500 |
list_type | query | string | false | Type of List to return. This value can be compact, summary, or full indicating the number of fields included in each element returned |
name | query | string | false | Name value expected or comma separated list of values (Detroit, Madrid, New York) |
created_at_from | query | integer | false | CreatedAt From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
created_at_until | query | integer | false | CreatedAt Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"company": "56b1258a9f176c1100e7e993",
"created_at": "2020-01-28T09:13:30.466Z",
"departments": [
"56b1258a9f176c1100e7e993"
],
"description": "This is a description about the group segmentation",
"external_id": "1234,AB435BD,X56b1258a",
"grades": [
"56b1258a9f176c1100e7e993"
],
"id": "56b1258a9f176c1100e7e993",
"levels": [
"56b1258a9f176c1100e7e993"
],
"locations": [
"56b1258a9f176c1100e7e993"
],
"name": "Featured",
"teams": [
"56b1258a9f176c1100e7e993"
],
"updated_at": "2020-04-28T09:13:30.466Z",
"user": "56b1258a9f176c1100e7e993"
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Creates a Group
Code Sample
# You can also use wget
curl -X POST https://usw2-oapi.continu.co/api/v1/data/groups \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint creates a Group instance
Body parameter
{
"company": "56b1258a9f176c1100e7e993",
"created_at": "2020-01-28T09:13:30.466Z",
"departments": [
"56b1258a9f176c1100e7e993"
],
"description": "This is a description about the group segmentation",
"external_id": "1234,AB435BD,X56b1258a",
"grades": [
"56b1258a9f176c1100e7e993"
],
"id": "56b1258a9f176c1100e7e993",
"levels": [
"56b1258a9f176c1100e7e993"
],
"locations": [
"56b1258a9f176c1100e7e993"
],
"name": "Featured",
"teams": [
"56b1258a9f176c1100e7e993"
],
"updated_at": "2020-04-28T09:13:30.466Z",
"user": "56b1258a9f176c1100e7e993"
}
HTTP Request
POST https://usw2-oapi.continu.co/api/v1/data/groups
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.Group | true | The Group to create |
» company | body | string | false | none |
» created_at | body | string | false | none |
» departments | body | [string] | false | none |
» description | body | string | false | none |
» external_id | body | string | false | none |
» grades | body | [string] | false | none |
» id | body | string | false | none |
» levels | body | [string] | false | none |
» locations | body | [string] | false | none |
» name | body | string | false | none |
» teams | body | [string] | false | none |
» updated_at | body | string | false | none |
» user | body | string | false | none |
Example Response
201 Response
Responses
Status | Meaning | Description |
---|---|---|
201 | Created | Created |
400 | Bad Request | Bad Request |
409 | Conflict | Conflict |
500 | Internal Server Error | Internal Server Error |
Get Group by id or external_id
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/groups/{id} \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint gets the group corresponding to the given id or external_id.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/groups/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the group requested. |
external_id | query | string | false | Optional true/false indicating to use external_id field to match the {id} param |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Update a Group
Code Sample
# You can also use wget
curl -X PATCH https://usw2-oapi.continu.co/api/v1/data/groups/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint replaces/updates a whole Location instance
Body parameter
{
"company": "56b1258a9f176c1100e7e993",
"created_at": "2020-01-28T09:13:30.466Z",
"departments": [
"56b1258a9f176c1100e7e993"
],
"description": "This is a description about the group segmentation",
"external_id": "1234,AB435BD,X56b1258a",
"grades": [
"56b1258a9f176c1100e7e993"
],
"id": "56b1258a9f176c1100e7e993",
"levels": [
"56b1258a9f176c1100e7e993"
],
"locations": [
"56b1258a9f176c1100e7e993"
],
"name": "Featured",
"teams": [
"56b1258a9f176c1100e7e993"
],
"updated_at": "2020-04-28T09:13:30.466Z",
"user": "56b1258a9f176c1100e7e993"
}
HTTP Request
PATCH https://usw2-oapi.continu.co/api/v1/data/groups/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the Group requested to be replaced. |
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.Group | true | The Group to replace |
» company | body | string | false | none |
» created_at | body | string | false | none |
» departments | body | [string] | false | none |
» description | body | string | false | none |
» external_id | body | string | false | none |
» grades | body | [string] | false | none |
» id | body | string | false | none |
» levels | body | [string] | false | none |
» locations | body | [string] | false | none |
» name | body | string | false | none |
» teams | body | [string] | false | none |
» updated_at | body | string | false | none |
» user | body | string | false | none |
Example Response
400 Response
Responses
Status | Meaning | Description |
---|---|---|
204 | No Content | none |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |
Levels
Get Level List
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/levels \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Level's briefs, you may return them as a list size of 50 records, 100, or 500, and in a "compact", "summary", or "full" list type. If omitted, the default values for the list are "compact" and 50 records. If you want to return the next batch of 50, 100, or 500 records The list To get the next group of records send id_from argument with the last id you received.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/levels
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id_from | query | string | false | Optional Id from the last record previously returned. This will be the Id from which data is returned |
list_size | query | string | false | Size of the returned list. This value can be 50, 100, or 500 |
list_type | query | string | false | Type of List to return. This value can be compact, summary, or full indicating the number of fields included in each element returned |
name | query | string | false | Name value expected or comma separated list of values (Intern, Junior, VP, S1, A1) |
created_at_from | query | integer | false | CreatedAt From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
created_at_until | query | integer | false | CreatedAt Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"children": [
"56b9938a9f176c1100e7e125"
],
"company": "56b1258a9f176c1100e7e993",
"id": "56b1258a9f176c1100e7e993",
"level": 1,
"localized_names": "fr:featured-fr,de:gerfeatured,pt_br:Novidades,es_la:Spanish Featured,deu:Neuigkeiten",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Creates a Level (An Organization Level)
Code Sample
# You can also use wget
curl -X POST https://usw2-oapi.continu.co/api/v1/data/levels \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint creates a Level
Body parameter
{
"level": 1,
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
POST https://usw2-oapi.continu.co/api/v1/data/levels
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationInsert | true | The Level to create |
» level | body | integer | false | none |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
201 Response
Responses
Status | Meaning | Description |
---|---|---|
201 | Created | Created |
400 | Bad Request | Bad Request |
409 | Conflict | Conflict |
500 | Internal Server Error | Internal Server Error |
Get Level by id
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/levels/{id} \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint gets the level corresponding to the given id.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/levels/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the level requested. |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Update a Level
Code Sample
# You can also use wget
curl -X PATCH https://usw2-oapi.continu.co/api/v1/data/levels/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint replaces/updates a whole Level instance
Body parameter
{
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
PATCH https://usw2-oapi.continu.co/api/v1/data/levels/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the Level requested to be replaced. |
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationUpdate | true | The Level to replace |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
400 Response
Responses
Status | Meaning | Description |
---|---|---|
204 | No Content | none |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |
Locations
Get Location List
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/locations \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Location's briefs, you may return them as a list size of 50 records, 100, or 500, and in a "compact", "summary", or "full" list type. If omitted, the default values for the list are "compact" and 50 records. If you want to return the next batch of 50, 100, or 500 records The list To get the next group of records send id_from argument with the last id you received.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/locations
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id_from | query | string | false | Optional Id from the last record previously returned. This will be the Id from which data is returned |
list_size | query | string | false | Size of the returned list. This value can be 50, 100, or 500 |
list_type | query | string | false | Type of List to return. This value can be compact, summary, or full indicating the number of fields included in each element returned |
name | query | string | false | Name value expected or comma separated list of values (Detroit, Madrid, New York) |
created_at_from | query | integer | false | CreatedAt From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
created_at_until | query | integer | false | CreatedAt Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"children": [
"56b9938a9f176c1100e7e125"
],
"company": "56b1258a9f176c1100e7e993",
"id": "56b1258a9f176c1100e7e993",
"level": 1,
"localized_names": "fr:featured-fr,de:gerfeatured,pt_br:Novidades,es_la:Spanish Featured,deu:Neuigkeiten",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Creates a Location
Code Sample
# You can also use wget
curl -X POST https://usw2-oapi.continu.co/api/v1/data/locations \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint creates a Location instance
Body parameter
{
"level": 1,
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
POST https://usw2-oapi.continu.co/api/v1/data/locations
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationInsert | true | The Location to create |
» level | body | integer | false | none |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
201 Response
Responses
Status | Meaning | Description |
---|---|---|
201 | Created | Created |
400 | Bad Request | Bad Request |
409 | Conflict | Conflict |
500 | Internal Server Error | Internal Server Error |
Get Location by id
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/locations/{id} \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint gets the location corresponding to the given id.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/locations/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the location requested. |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Update a Location
Code Sample
# You can also use wget
curl -X PUT https://usw2-oapi.continu.co/api/v1/data/locations/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint replaces/updates a whole Location instance
Body parameter
{
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
PUT https://usw2-oapi.continu.co/api/v1/data/locations/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the Location requested to be replaced. |
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationUpdate | true | The Location to replace |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
400 Response
Responses
Status | Meaning | Description |
---|---|---|
204 | No Content | none |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |
Skills
Get Skill List
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/skills \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Skill briefs, you may return them as a list size of 50 records, 100, or 500, and in a "compact", "summary", or "full" list type. If omitted, the default values for the list are "compact" and 50 records. If you want to return the next batch of 50, 100, or 500 records The list To get the next group of records send id_from argument with the last id you received.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/skills
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id_from | query | string | false | Optional Id from the last record previously returned. This will be the Id from which data is returned |
list_size | query | string | false | Size of the returned list. This value can be 50, 100, or 500 |
list_type | query | string | false | Type of List to return. This value can be compact, summary, or full indicating the number of fields included in each element returned |
name | query | string | false | Name value expected or comma separated list of values (JavaScript, Speaks German, PowerPoint) |
created_at_from | query | integer | false | CreatedAt From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
created_at_until | query | integer | false | CreatedAt Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"blocked": false,
"blocked_date": "2020-04-28T09:13:30.466Z",
"company": "56b1258a9f176c1100e7e993",
"created_at": "2020-01-28T09:13:30.466Z",
"id": "56b1258a9f176c1100e7e993",
"name": "JavaScript",
"user": "56b1258a9f176c1100e7e993",
"user_blocked": "56b1258a9f176c1100e7e993"
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Creates a Skill
Code Sample
# You can also use wget
curl -X POST https://usw2-oapi.continu.co/api/v1/data/skills \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint creates a Skill instance
Body parameter
{
"blocked": false,
"blocked_date": "2020-04-28T09:13:30.466Z",
"company": "56b1258a9f176c1100e7e993",
"created_at": "2020-01-28T09:13:30.466Z",
"id": "56b1258a9f176c1100e7e993",
"name": "JavaScript",
"updated_at": "2020-04-28T09:13:30.466Z",
"user": "56b1258a9f176c1100e7e993",
"user_blocked": "56b1258a9f176c1100e7e993"
}
HTTP Request
POST https://usw2-oapi.continu.co/api/v1/data/skills
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.Skill | true | The Skill to create |
» blocked | body | boolean | false | none |
» blocked_date | body | string | false | none |
» company | body | string | false | none |
» created_at | body | string | false | none |
» id | body | string | false | none |
» name | body | string | false | none |
» updated_at | body | string | false | none |
» user | body | string | false | none |
» user_blocked | body | string | false | none |
Example Response
201 Response
Responses
Status | Meaning | Description |
---|---|---|
201 | Created | Created |
400 | Bad Request | Bad Request |
409 | Conflict | Conflict |
500 | Internal Server Error | Internal Server Error |
Get Skill by id
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/skills/{id} \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint gets the skill corresponding to the given id.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/skills/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the skill requested. |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Replace a Skill
Code Sample
# You can also use wget
curl -X PUT https://usw2-oapi.continu.co/api/v1/data/skills/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint replaces/updates a whole Skill instance
Body parameter
{
"blocked": false,
"blocked_date": "2020-04-28T09:13:30.466Z",
"company": "56b1258a9f176c1100e7e993",
"created_at": "2020-01-28T09:13:30.466Z",
"id": "56b1258a9f176c1100e7e993",
"name": "JavaScript",
"updated_at": "2020-04-28T09:13:30.466Z",
"user": "56b1258a9f176c1100e7e993",
"user_blocked": "56b1258a9f176c1100e7e993"
}
HTTP Request
PUT https://usw2-oapi.continu.co/api/v1/data/skills/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the Skill requested to be replaced. |
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.Skill | true | The Skill to replace |
» blocked | body | boolean | false | none |
» blocked_date | body | string | false | none |
» company | body | string | false | none |
» created_at | body | string | false | none |
» id | body | string | false | none |
» name | body | string | false | none |
» updated_at | body | string | false | none |
» user | body | string | false | none |
» user_blocked | body | string | false | none |
Example Response
400 Response
Responses
Status | Meaning | Description |
---|---|---|
204 | No Content | none |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |
Teams
Get Team List
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/teams \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all Team's briefs, you may return them as a list size of 50 records, 100, or 500, and in a "compact", "summary", or "full" list type. If omitted, the default values for the list are "compact" and 50 records. If you want to return the next batch of 50, 100, or 500 records The list To get the next group of records send id_from argument with the last id you received.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/teams
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id_from | query | string | false | Optional Id from the last record previously returned. This will be the Id from which data is returned |
list_size | query | string | false | Size of the returned list. This value can be 50, 100, or 500 |
list_type | query | string | false | Type of List to return. This value can be compact, summary, or full indicating the number of fields included in each element returned |
name | query | string | false | Name value expected or comma separated list of values (A-Team, Engineers, Master of Sales) |
created_at_from | query | integer | false | CreatedAt From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
created_at_until | query | integer | false | CreatedAt Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"children": [
"56b9938a9f176c1100e7e125"
],
"company": "56b1258a9f176c1100e7e993",
"id": "56b1258a9f176c1100e7e993",
"level": 1,
"localized_names": "fr:featured-fr,de:gerfeatured,pt_br:Novidades,es_la:Spanish Featured,deu:Neuigkeiten",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Creates a Team
Code Sample
# You can also use wget
curl -X POST https://usw2-oapi.continu.co/api/v1/data/teams \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint creates a Team instance
Body parameter
{
"level": 1,
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
POST https://usw2-oapi.continu.co/api/v1/data/teams
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationInsert | true | The Team to create |
» level | body | integer | false | none |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
201 Response
Responses
Status | Meaning | Description |
---|---|---|
201 | Created | Created |
400 | Bad Request | Bad Request |
409 | Conflict | Conflict |
500 | Internal Server Error | Internal Server Error |
Get Team by id
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/teams/{id} \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint gets the team corresponding to the given id.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/teams/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the team requested. |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Update a Team
Code Sample
# You can also use wget
curl -X PATCH https://usw2-oapi.continu.co/api/v1/data/teams/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint replaces/updates a whole Team instance
Body parameter
{
"localized_names": "fr:Mis en exergue,de:Empfohlen,pt_br:Novidades,es_la:Novedades",
"name": "Featured",
"parent": "56b1258a9f176c1100e7e993",
"show_external": true
}
HTTP Request
PATCH https://usw2-oapi.continu.co/api/v1/data/teams/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the Team requested to be replaced. |
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.SegmentationUpdate | true | The Team to replace |
» localized_names | body | string | false | none |
» name | body | string | false | none |
» parent | body | string | false | none |
» show_external | body | boolean | false | none |
Example Response
400 Response
Responses
Status | Meaning | Description |
---|---|---|
204 | No Content | none |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |
Users
Get User List
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/users \
-H 'Accept: application/json' \
-H 'Authorization: string'
This endpoint lists all user's briefs, you may return them as a list size of 50 records, 100, 1000, etc, and in a "compact", "summary", or "full" list type. If omitted, the default values for the list are "compact" and 50 records. You have the option to specify values for any of the fields returned regardless of the list type. This can be a single value, or lists for string fields like emails, roles, and even from/until ranges for date fields like create_at, or first_login. If you want to return the next batch of 50, 100, or 500 records The list To get the next group of records send id_from argument with the last id you received.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/users
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id_from | query | string | false | Optional Id from the last record previously returned. This will be the Id from which data is returned |
list_size | query | string | false | Size of the returned list. This value can be 50, 100, 500, 1000, or 5000 |
list_type | query | string | false | Type of List to return. This value can be compact, summary, or full indicating the number of fields included in each element returned |
first_name | query | string | false | First Name value expected or comma separated list of values (George, Becky, Michael) |
last_name | query | string | false | Last Name value expected or comma separated list of values (Smith, Senna, Carlson) |
query | string | false | Email value or comma separated list of emails for which to return values | |
role | query | string | false | Role value expected or comma separated list of values (admin, user, external) |
external_id | query | string | false | UserId value expected (employee id, phone number, client defined id for users) |
locations | query | string | false | Location value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
departments | query | string | false | Department value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
teams | query | string | false | Team value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
levels | query | string | false | Level value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
grades | query | string | false | Grade value expected or comma separated list of values (56b9938a9f176c1100e7e156, 56b9938a9f176c1100e7e152, 56b9938a9f176c1100e7e154) |
is_manager | query | string | false | IsManager value expected (true/false, t/f, 1/0) |
is_collaborator | query | string | false | IsCollaborator value expected (true/false, t/f, 1/0) |
is_suspended | query | string | false | IsSuspended value expected (true/false, t/f, 1/0) |
suspended_on_from | query | integer | false | SuspendedOn From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
suspended_on_until | query | integer | false | SuspendedOn Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
first_login_from | query | integer | false | FirstLogin From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
first_login_until | query | integer | false | FirstLogin Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
last_login_from | query | integer | false | LastLogin From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
last_login_until | query | integer | false | LastLogin Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
updated_at_from | query | integer | false | UpdatedAt From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
updated_at_until | query | integer | false | UpdatedAt Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
created_at_from | query | integer | false | CreatedAt From date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
created_at_until | query | integer | false | CreatedAt Until date in Unix time (AKA Epoch time, seconds since 00:00:00 UTC on 1 January 1970) |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
[
{
"company": "56b1258a9f176c1100e7e993",
"created_at": "2020-01-28T09:13:30.466Z",
"email": "theresa@continu.co",
"first_login": "2020-01-28T09:13:30.466Z",
"first_name": "Theresa",
"full_name": "Theresa Jenkins",
"groups": [
"56b9938a9f176c1100e7e156"
],
"hired_on": "2020-04-28T09:13:30.466Z",
"id": "56b1258a9f176c1100e7e993",
"image": "https://d2277n3gvptnup.cloudfront.net/images/afcaf0c3-b0db-4313-b42e-bcabdfae35cb.jpg",
"is_collaborator": true,
"is_manager": false,
"is_suspended": false,
"job_title": "Marketing Manager",
"language": "en",
"last_login": "2020-04-28T09:13:30.466Z",
"last_name": "Jenkins",
"linked_departments": [
"56b9938a9f176c1100e7e156"
],
"linked_grade": "56b9938a9f176c1100e7e156",
"linked_locations": [
"56b9938a9f176c1100e7e125"
],
"linked_org_level": "56b9938a9f176c1100e7e156",
"linked_teams": [
"56b9938a9f176c1100e7e156"
],
"managing_groups": [
"56b9938a9f176c1100e7e156"
],
"role": "user",
"suspended_on": "2020-04-28T09:13:30.466Z",
"updated_at": "2020-04-28T09:13:30.466Z",
"userid": "123456789"
}
]
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Creates a User
Code Sample
# You can also use wget
curl -X POST https://usw2-oapi.continu.co/api/v1/data/users \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint creates a User instance
Body parameter
{
"address": "21 Jump St",
"buddy_email": "buddy@continu.co",
"company": "56b1258a9f176c1100e7e993",
"country": "USA",
"created_at": "2020-01-28T09:13:30.466Z",
"distributor": "Distributor A",
"email": "theresa@continu.co",
"first_login": "2020-01-28T09:13:30.466Z",
"first_name": "Theresa",
"full_name": "Theresa Jenkins",
"group": "Group A",
"groups": [
"56b9938a9f176c1100e7e156"
],
"hired_on": "2020-04-28T09:13:30.466Z",
"id": "56b1258a9f176c1100e7e993",
"image": "https://d2277n3gvptnup.cloudfront.net/images/afcaf0c3-b0db-4313-b42e-bcabdfae35cb.jpg",
"is_collaborator": true,
"is_manager": false,
"is_suspended": false,
"job_title": "Marketing Manager",
"language": "en",
"last_login": "2020-04-28T09:13:30.466Z",
"last_name": "Jenkins",
"last_onboarding_email": "2020-01-28T09:13:30.466Z",
"last_reminded_email": "2020-01-28T09:13:30.466Z",
"linked_departments": [
"56b9938a9f176c1100e7e156"
],
"linked_grade": "56b9938a9f176c1100e7e156",
"linked_locations": [
"56b9938a9f176c1100e7e125"
],
"linked_org_level": "56b9938a9f176c1100e7e156",
"linked_teams": [
"56b9938a9f176c1100e7e156"
],
"manager_configuration": {
"allow_adding_group_manager": false,
"allow_user_creation": true,
"allow_user_edit": false,
"disable_assignment_completion": true,
"disable_assignment_edit": true,
"disable_assignment_removal": false,
"disable_assignments": true,
"hide_options": [
"linked_grade"
],
"hide_non_managing_groups": true,
"restricted_editable_fields": [
"email"
],
"restricted_user_edit": true,
"segmentation_required": [
"linked_locations"
],
"segmentation_subset": [
"linked_departments"
]
},
"manager_email": "manager@continu.co",
"managing_groups": [
"56b9938a9f176c1100e7e156"
],
"password": "my password",
"provisioning_key": "string",
"provisioning_status": "inviting",
"region": "Central USA",
"role": "user",
"skills": [
"56b9938a9f176c1100e7e156"
],
"slack_dc": "A3Q47DZPB",
"slack_id": "U0CSVAS3Z",
"slack_last_attempt": "2020-01-28T09:13:30.466Z",
"social_links": [
{
"name": "linkedin",
"value": "https://link.to.linkedin.com"
}
],
"suspended_on": "2020-04-28T09:13:30.466Z",
"updated_at": "2020-04-28T09:13:30.466Z",
"userid": "123456789"
}
HTTP Request
POST https://usw2-oapi.continu.co/api/v1/data/users
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | The Authorization Header and Token |
mute | query | string | false | Optionally, set to true if you don't want any emails to be sent. Default is false. Allowed values true/false, t/f, 1/0. |
body | body | controllers.User | true | The User to create |
» address | body | string | false | none |
» buddy_email | body | string | false | none |
» company | body | string | false | none |
» country | body | string | false | none |
» created_at | body | string | false | none |
» distributor | body | string | false | none |
body | string | false | none | |
» first_login | body | string | false | none |
» first_name | body | string | false | none |
» full_name | body | string | false | none |
» group | body | string | false | none |
» groups | body | [string] | false | none |
» hired_on | body | string | false | none |
» id | body | string | false | none |
» image | body | string | false | none |
» is_collaborator | body | boolean | false | none |
» is_manager | body | boolean | false | none |
» is_suspended | body | boolean | false | none |
» job_title | body | string | false | none |
» language | body | string | false | none |
» last_login | body | string | false | none |
» last_name | body | string | false | none |
» last_onboarding_email | body | string | false | none |
» last_reminded_email | body | string | false | none |
» linked_departments | body | [string] | false | none |
» linked_grade | body | string | false | none |
» linked_locations | body | [string] | false | none |
» linked_org_level | body | string | false | none |
» linked_teams | body | [string] | false | none |
» manager_configuration | body | controllers.ManagerConfiguration | false | none |
»» allow_adding_group_manager | body | boolean | false | none |
»» allow_user_creation | body | boolean | false | none |
»» allow_user_edit | body | boolean | false | none |
»» disable_assignment_completion | body | boolean | false | none |
»» disable_assignment_edit | body | boolean | false | none |
»» disable_assignment_removal | body | boolean | false | none |
»» disable_assignments | body | boolean | false | none |
»» hide_options | body | [string] | false | none |
»» hide_non_managing_groups | body | boolean | false | none |
»» restricted_editable_fields | body | [string] | false | none |
»» restricted_user_edit | body | boolean | false | none |
»» segmentation_required | body | [string] | false | none |
»» segmentation_subset | body | [string] | false | none |
» manager_email | body | string | false | none |
» managing_groups | body | [string] | false | none |
» password | body | string | false | none |
» provisioning_key | body | string | false | none |
» provisioning_status | body | string | false | none |
» region | body | string | false | none |
» role | body | string | false | none |
» skills | body | [string] | false | none |
» slack_dc | body | string | false | none |
» slack_id | body | string | false | none |
» slack_last_attempt | body | string | false | none |
» social_links | body | [controllers.SocialLink] | false | none |
»» name | body | string | false | none |
»» value | body | string | false | none |
» suspended_on | body | string | false | none |
» updated_at | body | string | false | none |
» userid | body | string | false | none |
Example Response
201 Response
Responses
Status | Meaning | Description |
---|---|---|
201 | Created | Created |
400 | Bad Request | Bad Request |
409 | Conflict | Conflict |
500 | Internal Server Error | Internal Server Error |
Get User by id
Code Sample
# You can also use wget
curl -X GET https://usw2-oapi.continu.co/api/v1/data/users/{id} \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint gets the user corresponding to the given id.
HTTP Request
GET https://usw2-oapi.continu.co/api/v1/data/users/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the user requested. |
Authorization | header | string | true | The Authorization Header and Token |
Example Response
200 Response
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
404 | Not Found | Not Found |
500 | Internal Server Error | Internal Server Error |
Updates/Patches a User
Code Sample
# You can also use wget
curl -X PATCH https://usw2-oapi.continu.co/api/v1/data/users/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
This endpoint updates a partial User instance
Body parameter
{
"address": "21 Jump St",
"buddy_email": "buddy@continu.co",
"country": "USA",
"distributor": "Distributor A",
"email": "theresa@continu.co",
"first_name": "Theresa",
"group": "Group A",
"groups": [
"56b9938a9f176c1100e7e156"
],
"hired_on": "2020-04-28T09:13:30.466Z",
"image": "https://d2277n3gvptnup.cloudfront.net/images/afcaf0c3-b0db-4313-b42e-bcabdfae35cb.jpg",
"is_collaborator": true,
"is_manager": false,
"is_suspended": false,
"job_title": "Marketing Manager",
"language": "en",
"last_name": "Jenkins",
"linked_departments": [
"56b9938a9f176c1100e7e156"
],
"linked_grade": "56b9938a9f176c1100e7e156",
"linked_locations": [
"56b9938a9f176c1100e7e125"
],
"linked_org_level": "56b9938a9f176c1100e7e156",
"linked_teams": [
"56b9938a9f176c1100e7e156"
],
"manager_configuration": {
"allow_adding_group_manager": false,
"allow_user_creation": true,
"allow_user_edit": false,
"disable_assignment_completion": true,
"disable_assignment_edit": true,
"disable_assignment_removal": false,
"disable_assignments": true,
"hide_options": [
"linked_grade"
],
"hide_non_managing_groups": true,
"restricted_editable_fields": [
"email"
],
"restricted_user_edit": true,
"segmentation_required": [
"linked_locations"
],
"segmentation_subset": [
"linked_departments"
]
},
"manager_email": "manager@continu.co",
"managing_groups": [
"56b9938a9f176c1100e7e156"
],
"password": "my password",
"region": "Central USA",
"role": "user",
"skills": [
"56b9938a9f176c1100e7e156"
],
"slack_dc": "A3Q47DZPB",
"slack_id": "U0CSVAS3Z",
"social_links": [
{
"name": "linkedin",
"value": "https://link.to.linkedin.com"
}
],
"userid": "123456789"
}
HTTP Request
PATCH https://usw2-oapi.continu.co/api/v1/data/users/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Id for the user requested to be replaced. |
Authorization | header | string | true | The Authorization Header and Token |
body | body | controllers.UpdateUser | true | The UpdateUser to patch User with |
» address | body | string | false | none |
» buddy_email | body | string | false | none |
» country | body | string | false | none |
» distributor | body | string | false | none |
body | string | false | none | |
» first_name | body | string | false | none |
» group | body | string | false | none |
» groups | body | [string] | false | none |
» hired_on | body | string | false | none |
» image | body | string | false | none |
» is_collaborator | body | boolean | false | none |
» is_manager | body | boolean | false | none |
» is_suspended | body | boolean | false | none |
» job_title | body | string | false | none |
» language | body | string | false | none |
» last_name | body | string | false | none |
» linked_departments | body | [string] | false | none |
» linked_grade | body | string | false | none |
» linked_locations | body | [string] | false | none |
» linked_org_level | body | string | false | none |
» linked_teams | body | [string] | false | none |
» manager_configuration | body | controllers.ManagerConfiguration | false | none |
»» allow_adding_group_manager | body | boolean | false | none |
»» allow_user_creation | body | boolean | false | none |
»» allow_user_edit | body | boolean | false | none |
»» disable_assignment_completion | body | boolean | false | none |
»» disable_assignment_edit | body | boolean | false | none |
»» disable_assignment_removal | body | boolean | false | none |
»» disable_assignments | body | boolean | false | none |
»» hide_options | body | [string] | false | none |
»» hide_non_managing_groups | body | boolean | false | none |
»» restricted_editable_fields | body | [string] | false | none |
»» restricted_user_edit | body | boolean | false | none |
»» segmentation_required | body | [string] | false | none |
»» segmentation_subset | body | [string] | false | none |
» manager_email | body | string | false | none |
» managing_groups | body | [string] | false | none |
» password | body | string | false | none |
» region | body | string | false | none |
» role | body | string | false | none |
» skills | body | [string] | false | none |
» slack_dc | body | string | false | none |
» slack_id | body | string | false | none |
» social_links | body | [controllers.SocialLink] | false | none |
»» name | body | string | false | none |
»» value | body | string | false | none |
» userid | body | string | false | none |
Example Response
400 Response
Responses
Status | Meaning | Description |
---|---|---|
204 | No Content | none |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |