Documentation Powered by ReDoc

Swagger Worklete (1.0.0)

Download OpenAPI specification:Download

License: MIT

auth

Creating a user

Request Body schema: application/json
username
string

An user identification used to access worklete. Required to be of length 4 or greater. The username is unique across all users.

first_name
string
last_name
string
password
string <password>

The password for the user. Required to be of length 6 or greater.

invite_code
string

The invite_code is a unique 6 alpha-numeic string that identifies the membership.

provider
string
Enum: "email" "username"

Responses

200

User session

500

Unexpected error

post /auth

development

http://localhost:3001/api/v1/auth

stage

https://worklete-server-stage.herokuapp.com/api/v1/auth

production

https://connection.worklete.com/api/v1/auth

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "workleteuser",
  • "first_name": "John",
  • "last_name": "Doe",
  • "password": "password",
  • "invite_code": "4DD47K",
  • "provider": "username"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Update user

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
username
string

An identification used by a person to access worklete.

first_name
string
last_name
string
provider
string
Enum: "email" "username"

Responses

200

Successfully change the user's first_name

404

Resource not found

500

Unexpected error

patch /auth

development

http://localhost:3001/api/v1/auth

stage

https://worklete-server-stage.herokuapp.com/api/v1/auth

production

https://connection.worklete.com/api/v1/auth

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "workleteuser",
  • "first_name": "John",
  • "last_name": "Doe",
  • "provider": "username"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Change password

query Parameters
password
required
string
Example: password=worklete123
password_confirmation
required
string
Example: password_confirmation=worklete123
header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
password
string <password>
password_confirmation
string <password>

Responses

200

Successfully change password

401

Unauthorized

put /auth/password

development

http://localhost:3001/api/v1/auth/password

stage

https://worklete-server-stage.herokuapp.com/api/v1/auth/password

production

https://connection.worklete.com/api/v1/auth/password

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "password",
  • "password_confirmation": "password"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "language_code": "en",
  • "worklete_employee": false,
  • "created_at": "2019-05-01T16:44:18.407Z",
  • "updated_at": "2019-05-01T16:44:18.407Z",
  • "provider": "username",
  • "uid": "string",
  • "encrypted_password": "string",
  • "reset_password_token": "string",
  • "reset_password_sent_at": "string",
  • "allow_password_change": false,
  • "remember_created_at": "2019-05-01T16:44:18.407Z",
  • "tokens": { },
  • "sign_in_count": 0,
  • "current_sign_in_at": "2019-05-01T16:44:18.407Z",
  • "last_sign_in_at": "2019-05-01T16:44:18.407Z",
  • "current_sign_in_ip": "127.0.0.1",
  • "last_sign_in_ip": "127.0.0.1",
  • "organizations":
    [
    ],
  • "memberships":
    [
    ]
}

Sign in a user

Request Body schema: application/json
username
string

An identification used by a person to access worklete.

password
string <password>
provider
string
Enum: "email" "username"

Responses

200

Sign in with the provided credentials

401

Unauthorized

post /auth/sign_in

development

http://localhost:3001/api/v1/auth/sign_in

stage

https://worklete-server-stage.herokuapp.com/api/v1/auth/sign_in

production

https://connection.worklete.com/api/v1/auth/sign_in

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "johndoe",
  • "password": "password",
  • "provider": "username"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Sign out a user

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Signed out successful

404

Resource not found

delete /auth/sign_out

development

http://localhost:3001/api/v1/auth/sign_out

stage

https://worklete-server-stage.herokuapp.com/api/v1/auth/sign_out

production

https://connection.worklete.com/api/v1/auth/sign_out

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true
}

Check username availability. This API requires no authentication.

path Parameters
username
required
string
Example: workleteuser

An identification used by a person to access worklete.

Responses

200

Username availability

500

Unexpected error

get /auth/username/{username}

development

http://localhost:3001/api/v1/auth/username/{username}

stage

https://worklete-server-stage.herokuapp.com/api/v1/auth/username/{username}

production

https://connection.worklete.com/api/v1/auth/username/{username}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "available": false
}

create a cognitio session and get the details

Responses

200

Successfully created a Cognito session.

get /cognito/session

development

http://localhost:3001/api/v1/cognito/session

stage

https://worklete-server-stage.herokuapp.com/api/v1/cognito/session

production

https://connection.worklete.com/api/v1/cognito/session

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Retrieve the invitation

path Parameters
code
required
string
Example: 289BZP

Invitation code

Responses

200

The invitation with organization name and membership name

404

Resource not found

get /invitations/{code}

development

http://localhost:3001/api/v1/invitations/{code}

stage

https://worklete-server-stage.herokuapp.com/api/v1/invitations/{code}

production

https://connection.worklete.com/api/v1/invitations/{code}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "55ee9a57-6a25-47da-8c35-34a8343f3a55",
  • "organization_name": "Worklete",
  • "membership_first_name": "Jane",
  • "membership_last_name": "Doe",
  • "invite_code": "string"
}

Retrieve a user session

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Successful

500

Unexpected error

get /session

development

http://localhost:3001/api/v1/session

stage

https://worklete-server-stage.herokuapp.com/api/v1/session

production

https://connection.worklete.com/api/v1/session

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Sign out the user

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Successful

500

Unexpected error

delete /session

development

http://localhost:3001/api/v1/session

stage

https://worklete-server-stage.herokuapp.com/api/v1/session

production

https://connection.worklete.com/api/v1/session

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

get SAML service provider metadata

Responses

200

Successfully returns metadata XML

get /saml/metadata

development

http://localhost:3001/api/v1/saml/metadata

stage

https://worklete-server-stage.herokuapp.com/api/v1/saml/metadata

production

https://connection.worklete.com/api/v1/saml/metadata

Final endpoint for a SAML IdP to send a SAML Response

Responses

200

Receives a SAML response and redirects with authentication tokens

get /saml/consume

development

http://localhost:3001/api/v1/saml/consume

stage

https://worklete-server-stage.herokuapp.com/api/v1/saml/consume

production

https://connection.worklete.com/api/v1/saml/consume

users

Get a membership

path Parameters
membership_id
required
string <uuid>

Membership ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

A membership object

401

Unauthorized

500

Unexpected error

get /memberships/{membership_id}

development

http://localhost:3001/api/v1/memberships/{membership_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/memberships/{membership_id}

production

https://connection.worklete.com/api/v1/memberships/{membership_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update admin permission

path Parameters
membership_id
required
string <uuid>

Membership ID

query Parameters
org_admin
required
boolean
Example: org_admin=false

Update the user's admin permission to either true or false

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

The updated membership object

403

Forbidden

500

Unexpected error

patch /memberships/{membership_id}/admin_permission

development

http://localhost:3001/api/v1/memberships/{membership_id}/admin_permission

stage

https://worklete-server-stage.herokuapp.com/api/v1/memberships/{membership_id}/admin_permission

production

https://connection.worklete.com/api/v1/memberships/{membership_id}/admin_permission

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

List all users

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

An array of users

401

Unauthorized

500

Unexpected error

get /users

development

http://localhost:3001/api/v1/users

stage

https://worklete-server-stage.herokuapp.com/api/v1/users

production

https://connection.worklete.com/api/v1/users

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Retrieve a user

path Parameters
user_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

User ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Retrieve the user

401

Unauthorized

get /users/{user_id}

development

http://localhost:3001/api/v1/users/{user_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/users/{user_id}

production

https://connection.worklete.com/api/v1/users/{user_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update user

path Parameters
id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

User ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
email
string <email> Nullable

Responses

200

True or false

500

Unexpected error

patch /users/{id}

development

http://localhost:3001/api/v1/users/{id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/users/{id}

production

https://connection.worklete.com/api/v1/users/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "email": "person@worklete.com"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
true

Request user password reset

path Parameters
id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

User ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
username
string

Responses

200

True or false

500

Unexpected error

patch /users/{id}/password_reset

development

http://localhost:3001/api/v1/users/{id}/password_reset

stage

https://worklete-server-stage.herokuapp.com/api/v1/users/{id}/password_reset

production

https://connection.worklete.com/api/v1/users/{id}/password_reset

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "workleteusername"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
true

teams

Get a list of teams that a membership belongs to

path Parameters
membership_id
required
string <uuid>
Example: 0066c21a-bdb2-4c9c-84eb-a3c1b7f24440

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

An array of teams

500

Unexpected error

get /memberships/{membership_id}/my_teams

development

http://localhost:3001/api/v1/memberships/{membership_id}/my_teams

stage

https://worklete-server-stage.herokuapp.com/api/v1/memberships/{membership_id}/my_teams

production

https://connection.worklete.com/api/v1/memberships/{membership_id}/my_teams

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Retrieve a team

path Parameters
team_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Retrieve the team within an organization

401

Unauthorized

get /teams/{team_id}

development

http://localhost:3001/api/v1/teams/{team_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}

production

https://connection.worklete.com/api/v1/teams/{team_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update a team

path Parameters
team_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
name
string

Responses

200

Retrieve the team within an organization

401

Unauthorized

put /teams/{team_id}

development

http://localhost:3001/api/v1/teams/{team_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}

production

https://connection.worklete.com/api/v1/teams/{team_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "team name"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update a team

path Parameters
team_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
name
string

Responses

200

Retrieve the team within an organization

401

Unauthorized

patch /teams/{team_id}

development

http://localhost:3001/api/v1/teams/{team_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}

production

https://connection.worklete.com/api/v1/teams/{team_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "team name"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Delete a team

path Parameters
team_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

204

Delete the team within an organization

401

Unauthorized

delete /teams/{team_id}

development

http://localhost:3001/api/v1/teams/{team_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}

production

https://connection.worklete.com/api/v1/teams/{team_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve team admins

path Parameters
team_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Retrieve list of team admins

401

Unauthorized

get /teams/{team_id}/admins

development

http://localhost:3001/api/v1/teams/{team_id}/admins

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}/admins

production

https://connection.worklete.com/api/v1/teams/{team_id}/admins

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Make a membership a team admin of the team

path Parameters
team_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
team_id
string <uuid>
membership_id
string <uuid>

Responses

200

Team admin created

401

Unauthorized

post /teams/{team_id}/admins

development

http://localhost:3001/api/v1/teams/{team_id}/admins

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}/admins

production

https://connection.worklete.com/api/v1/teams/{team_id}/admins

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "team_id": "ea7876b2-e174-418f-bef8-140559860a83",
  • "membership_id": "ea7876b2-e174-418f-bef8-140559860a83"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Revoke team admin access for a specific membership on the team

path Parameters
team_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Team ID

admin_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

A unique identifier for a membership

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Team admin created

401

Unauthorized

delete /teams/{team_id}/admins/{admin_id}

development

http://localhost:3001/api/v1/teams/{team_id}/admins/{admin_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}/admins/{admin_id}

production

https://connection.worklete.com/api/v1/teams/{team_id}/admins/{admin_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

List of Memberships with invitations Deprecated

path Parameters
team_id
required
string <uuid>

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

List of memberships

401

Unauthorized

500

Unexpected error

get /teams/{team_id}/invites

development

http://localhost:3001/api/v1/teams/{team_id}/invites

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}/invites

production

https://connection.worklete.com/api/v1/teams/{team_id}/invites

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

List of Memberships with invitations (both trained memberships and admins)

path Parameters
team_id
required
string <uuid>

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

List of memberships

401

Unauthorized

500

Unexpected error

get /teams/{team_id}/unused_invites

development

http://localhost:3001/api/v1/teams/{team_id}/unused_invites

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}/unused_invites

production

https://connection.worklete.com/api/v1/teams/{team_id}/unused_invites

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Retrieve worklete score data for the team

path Parameters
team_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Team ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Retrieve worklete score data

401

Unauthorized

get /teams/{team_id}/worklete_score

development

http://localhost:3001/api/v1/teams/{team_id}/worklete_score

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}/worklete_score

production

https://connection.worklete.com/api/v1/teams/{team_id}/worklete_score

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

organizations

List all organizations

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

An array of organizations

401

Unauthorized

get /organizations

development

http://localhost:3001/api/v1/organizations

stage

https://worklete-server-stage.herokuapp.com/api/v1/organizations

production

https://connection.worklete.com/api/v1/organizations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Update an organization

path Parameters
organization_id
required
string <uuid>

Organization ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
saml_info
string <string> Nullable

Responses

200

A organization object

401

Unauthorized

patch /organization/{organization_id}

development

http://localhost:3001/api/v1/organization/{organization_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/organization/{organization_id}

production

https://connection.worklete.com/api/v1/organization/{organization_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "saml_info": "<XML string>"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

List teams

path Parameters
organization_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Organization ID

query Parameters
page
integer <int32>
Default: 0

Pagination index

size
integer <int32>
Default: 25

Size of pagination

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

List of teams for the organization

401

Unauthorized

get /organizations/{organization_id}/teams

development

http://localhost:3001/api/v1/organizations/{organization_id}/teams

stage

https://worklete-server-stage.herokuapp.com/api/v1/organizations/{organization_id}/teams

production

https://connection.worklete.com/api/v1/organizations/{organization_id}/teams

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create a team

path Parameters
organization_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Organization ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
name
string

Responses

200

A team

post /organizations/{organization_id}/teams

development

http://localhost:3001/api/v1/organizations/{organization_id}/teams

stage

https://worklete-server-stage.herokuapp.com/api/v1/organizations/{organization_id}/teams

production

https://connection.worklete.com/api/v1/organizations/{organization_id}/teams

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "team name"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta": { }
}

Retrieves a team restricted by the member's access that powers the scoreboard.

path Parameters
organization_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Organization ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

List of teams for the organization

401

Unauthorized

get /organizations/{organization_id}/my_teams

development

http://localhost:3001/api/v1/organizations/{organization_id}/my_teams

stage

https://worklete-server-stage.herokuapp.com/api/v1/organizations/{organization_id}/my_teams

production

https://connection.worklete.com/api/v1/organizations/{organization_id}/my_teams

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "ea7876b2-e174-418f-bef8-140559860a83",
  • "name": "Team name",
  • "status": { },
  • "type": "LEARNER",
  • "teams":
    [
    ],
  • "parent_id": "ea7876b2-e174-418f-bef8-140559860a83",
  • "organization_id": "ea7876b2-e174-418f-bef8-140559860a83",
  • "overall_worklete_score": 83,
  • "overall_worklete_score_label": "NO_DATA"
}

Retrieves the worklete score for the member's metateam that powers the scoreboard.

path Parameters
organization_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Organization ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

List of teams for the organization

401

Unauthorized

get /organizations/{organization_id}/my_teams/worklete_score

development

http://localhost:3001/api/v1/organizations/{organization_id}/my_teams/worklete_score

stage

https://worklete-server-stage.herokuapp.com/api/v1/organizations/{organization_id}/my_teams/worklete_score

production

https://connection.worklete.com/api/v1/organizations/{organization_id}/my_teams/worklete_score

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "ea7876b2-e174-418f-bef8-140559860a83",
  • "name": "Team name",
  • "status": { },
  • "type": "LEARNER",
  • "teams":
    [
    ],
  • "parent_id": "ea7876b2-e174-418f-bef8-140559860a83",
  • "organization_id": "ea7876b2-e174-418f-bef8-140559860a83",
  • "overall_worklete_score": 83,
  • "overall_worklete_score_label": "NO_DATA",
  • "data_points":
    [
    ]
}

search

Search for team admin candidates

path Parameters
team_id
required
string <uuid>
Example: 0066c21a-bdb2-4c9c-84eb-a3c1b7f24440

Team ID

query Parameters
q
required
string
Example: q=Jane

Filters the user's list by first name and last name. It uses a Postgres 11.2 builtin fulltext search. https://www.postgresql.org/docs/11/textsearch.html

sort
string
Default: "first_name,last_name"
Example: sort=first_name,first_name%2Clast_name,-first_name

Sort the data by the requested fields. The sort order is ascending unless prefixed with a minus, in which case the order will be descending.

page
integer <int32>
Default: 1

The page

size
integer <int32>
Default: 25

The size of a page

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

An array of organization members

500

Unexpected error

get /teams/{team_id}/admins/potential_admins

development

http://localhost:3001/api/v1/teams/{team_id}/admins/potential_admins

stage

https://worklete-server-stage.herokuapp.com/api/v1/teams/{team_id}/admins/potential_admins

production

https://connection.worklete.com/api/v1/teams/{team_id}/admins/potential_admins

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

course player

My Course

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

The user's currently assigned course and assignment.

401

Unauthorized

403

Forbidden

500

Unexpected error

get /player/my_course

development

http://localhost:3001/api/v1/player/my_course

stage

https://worklete-server-stage.herokuapp.com/api/v1/player/my_course

production

https://connection.worklete.com/api/v1/player/my_course

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Get course for player

path Parameters
course_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Course identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

The course and the user's assignment

401

Unauthorized

403

Forbidden

500

Unexpected error

get /player/courses/{course_id}

development

http://localhost:3001/api/v1/player/courses/{course_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/player/courses/{course_id}

production

https://connection.worklete.com/api/v1/player/courses/{course_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Publishes the user's progress through the specified course

path Parameters
course_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Course identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
event_type
string
Enum: "complete" "update_progress"
player_session_id
string <uuid>
client_supplied_occured_at_in_ms
integer <int32>
progress
object

JSON representing the progress

Responses

200

The server acknowledges the supplied progress

401

Unauthorized

403

Bad Request

404

Resource not found

500

Unexpected error

post /player/courses/{course_id}/user_course_statuses

development

http://localhost:3001/api/v1/player/courses/{course_id}/user_course_statuses

stage

https://worklete-server-stage.herokuapp.com/api/v1/player/courses/{course_id}/user_course_statuses

production

https://connection.worklete.com/api/v1/player/courses/{course_id}/user_course_statuses

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "event_type": "complete",
  • "player_session_id": "ea7876b2-e174-418f-bef8-140559860a83",
  • "client_supplied_occured_at_in_ms": 0,
  • "progress": { }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

utility

generate a UUID

Responses

200

Successfully generated a UUID

get /uuid/new

development

http://localhost:3001/api/v1/uuid/new

stage

https://worklete-server-stage.herokuapp.com/api/v1/uuid/new

production

https://connection.worklete.com/api/v1/uuid/new

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

worklete admins

Create a Champion Certification for a User

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

user_id
required
string <uuid>

User identifier

date
required
string <date>

Date of champion certification

Responses

200

The champion certification is returned

401

Unauthorized

403

Forbidden

500

Unexpected error

post /worklete_admin/champion_certifications

development

http://localhost:3001/api/v1/worklete_admin/champion_certifications

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/champion_certifications

production

https://connection.worklete.com/api/v1/worklete_admin/champion_certifications

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Get a champion certification for a user

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

user_id
required
string <uuid>

Champion Certification identifier

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Unexpected error

get /worklete_admin/champion_certifications

development

http://localhost:3001/api/v1/worklete_admin/champion_certifications

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/champion_certifications

production

https://connection.worklete.com/api/v1/worklete_admin/champion_certifications

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Delete a champion certification

path Parameters
id
required
string <uuid>

Champion Certification identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Unexpected error

delete /worklete_admin/champion_certifications

development

http://localhost:3001/api/v1/worklete_admin/champion_certifications

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/champion_certifications

production

https://connection.worklete.com/api/v1/worklete_admin/champion_certifications

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve a list of courses

Worklete admins can view a list of all courses

path Parameters
organization_id
required
string <uuid>

Organization identifier

query Parameters
filter
string <string>
Example: filter=not_basics

Apply a filter when retrieving the list of courses.

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Returns an array of course objects

get /worklete_admin/courses

development

http://localhost:3001/api/v1/worklete_admin/courses

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/courses

production

https://connection.worklete.com/api/v1/worklete_admin/courses

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Create a course

Create a course on Worklete

header Parameters
access-token
required
string
Example: <string>

Access token

client
required
string
Example: <string>

Client is used to identify the user across multiple devices.

uid
required
string
Example: <string>

User identifier

Content-Type
required
string
Example: application/json

Responses

200

Returns the course object

post /worklete_admin/courses

development

http://localhost:3001/api/v1/worklete_admin/courses

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/courses

production

https://connection.worklete.com/api/v1/worklete_admin/courses

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve a single course

Worklete employees can view a single course

path Parameters
id
required
string
header Parameters
access-token
required
string
Example: <string>

Access token

client
required
string
Example: <string>

Client is used to identify the user across multiple devices.

uid
required
string
Example: <string>

User identifier

Content-Type
required
string
Example: application/json

Responses

200

Returns the course

get /worklete_admin/courses/{id}

development

http://localhost:3001/api/v1/worklete_admin/courses/{id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/courses/{id}

production

https://connection.worklete.com/api/v1/worklete_admin/courses/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update a course

Update a course on Worklete

path Parameters
id
required
string <uuid>
header Parameters
access-token
required
string
Example: <string>

Access token

client
required
string
Example: <string>

Client is used to identify the user across multiple devices.

uid
required
string
Example: <string>

User identifier

Content-Type
required
string
Example: application/json

Responses

200

Returns the course object

put /worklete_admin/courses/{id}

development

http://localhost:3001/api/v1/worklete_admin/courses/{id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/courses/{id}

production

https://connection.worklete.com/api/v1/worklete_admin/courses/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve a list of versions

Worklete admins can view a list of all versions

path Parameters
course_id
required
string <uuid>

Course identifier

query Parameters
sort
string
Default: "-created_at"
Example: sort=created_at,created_at%2Cpublished_at,-created_at

Sort the data by the requested fields. The sort order is ascending unless prefixed with a minus, in which case the order will be descending.

page
integer <int32>
Default: 1

The page

size
integer <int32>
Default: 25

The size of a page

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Returns an array of course version objects

401

Unauthorized

403

Bad Request

404

Resource not found

500

Unexpected error

get /worklete_admin/courses/{course_id}/versions

development

http://localhost:3001/api/v1/worklete_admin/courses/{course_id}/versions

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/courses/{course_id}/versions

production

https://connection.worklete.com/api/v1/worklete_admin/courses/{course_id}/versions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create a version

Create a version on Worklete

path Parameters
course_id
required
string <uuid>

Course identifier

header Parameters
access-token
required
string
Example: <string>

Access token

client
required
string
Example: <string>

Client is used to identify the user across multiple devices.

uid
required
string
Example: <string>

User identifier

Content-Type
required
string
Example: application/json
Request Body schema: application/json
data
object

Responses

200

Returns the version object

401

Unauthorized

403

Bad Request

404

Resource not found

500

Unexpected error

post /worklete_admin/courses/{course_id}/versions

development

http://localhost:3001/api/v1/worklete_admin/courses/{course_id}/versions

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/courses/{course_id}/versions

production

https://connection.worklete.com/api/v1/worklete_admin/courses/{course_id}/versions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve the version

Retrieve a version of the course

path Parameters
course_id
required
string <uuid>

Course identifier

version_id
required
string <uuid>

Version identifier

header Parameters
access-token
required
string
Example: <string>

Access token

client
required
string
Example: <string>

Client is used to identify the user across multiple devices.

uid
required
string
Example: <string>

User identifier

Content-Type
required
string
Example: application/json

Responses

200

Returns the version object

401

Unauthorized

403

Bad Request

404

Resource not found

500

Unexpected error

get /worklete_admin/courses/{course_id}/versions/{version_id}

development

http://localhost:3001/api/v1/worklete_admin/courses/{course_id}/versions/{version_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/courses/{course_id}/versions/{version_id}

production

https://connection.worklete.com/api/v1/worklete_admin/courses/{course_id}/versions/{version_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update a version

Update a draft version of a course

path Parameters
course_id
required
string <uuid>

Course identifier

version_id
required
string <uuid>

Version identifier

header Parameters
access-token
required
string
Example: <string>

Access token

client
required
string
Example: <string>

Client is used to identify the user across multiple devices.

uid
required
string
Example: <string>

User identifier

Content-Type
required
string
Example: application/json
Request Body schema: application/json
data
object

Responses

200

Returns the version object

401

Unauthorized

403

Bad Request

404

Resource not found

500

Unexpected error

patch /worklete_admin/courses/{course_id}/versions/{version_id}

development

http://localhost:3001/api/v1/worklete_admin/courses/{course_id}/versions/{version_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/courses/{course_id}/versions/{version_id}

production

https://connection.worklete.com/api/v1/worklete_admin/courses/{course_id}/versions/{version_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

List of invitations

query Parameters
id
string <uuid>

invitation identifiers

membership_id
string <uuid>

membership identifiers

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

List of invitations

401

Unauthorized

500

Unexpected error

get /worklete_admin/invitations

development

http://localhost:3001/api/v1/worklete_admin/invitations

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/invitations

production

https://connection.worklete.com/api/v1/worklete_admin/invitations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Retrieve invitation

path Parameters
id
required
string <uuid>

invitation identifiers

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Get invitation

401

Unauthorized

500

Unexpected error

get /worklete_admin/invitations/{invitation_id}

development

http://localhost:3001/api/v1/worklete_admin/invitations/{invitation_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/invitations/{invitation_id}

production

https://connection.worklete.com/api/v1/worklete_admin/invitations/{invitation_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Transcode video content

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
video_source_path
string

An s3 bucket path of a video file

caption_source_path
string

An s3 bucket path of a closed caption file

language_code
string

Two-letter language code of the closed caption track

Responses

200

The transcoded output paths

500

Unexpected error

post /worklete_admin/media_converter

development

http://localhost:3001/api/v1/worklete_admin/media_converter

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/media_converter

production

https://connection.worklete.com/api/v1/worklete_admin/media_converter

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "video_source_path": "s3://bucket-name/videos/congrats/05-Congrats_REBRAND.mp4",
  • "caption_source_path": "s3://bucket-name/videos/congrats/09-CongratsREBRAND.srt",
  • "language_code": "es"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve a list of memberships

query Parameters
organization_id
string
Example: organization_id=oid1%2Coid2%2Coid3

Organization identifiers

id
string
Example: id=mid1%2Cmid2%2Cmid3

Comma-delimited list of membership identifiers

team_id
string
Example: team_id=tid1%2Ctid2%2Ctid3

Comma-delimited list of team identifiers

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
string
Example: workleteuser

User identifier

Responses

200

A list of memberships

401

Unauthorized

403

Forbidden

500

Unexpected error

get /worklete_admin/memberships

development

http://localhost:3001/api/v1/worklete_admin/memberships

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/memberships

production

https://connection.worklete.com/api/v1/worklete_admin/memberships

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Retrieve the membership by id

path Parameters
membership_id
required
string <uuid>

Comma-delimited list of team identifiers

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
string
Example: workleteuser

User identifier

Responses

200

The membership for the ID

401

Unauthorized

403

Forbidden

500

Unexpected error

get /worklete_admin/memberships/{membership_id}

development

http://localhost:3001/api/v1/worklete_admin/memberships/{membership_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/memberships/{membership_id}

production

https://connection.worklete.com/api/v1/worklete_admin/memberships/{membership_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve a list of organizations

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

A list of organizations

401

Unauthorized

403

Forbidden

500

Unexpected error

get /worklete_admin/organizations

development

http://localhost:3001/api/v1/worklete_admin/organizations

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations

production

https://connection.worklete.com/api/v1/worklete_admin/organizations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create an organization

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
name
string
s3_integrations_folder
string <datetime>
saml_info
string <string> Nullable

Responses

200

Create the organization

401

Unauthorized

403

Forbidden

500

Unexpected error

post /worklete_admin/organizations

development

http://localhost:3001/api/v1/worklete_admin/organizations

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations

production

https://connection.worklete.com/api/v1/worklete_admin/organizations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "s3_integrations_folder": "string",
  • "saml_info": "<XML string>"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve the organization

path Parameters
organization_id
required
string <uuid>

Organization identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

The organization

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

get /worklete_admin/organizations/{organization_id}

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update the organization

path Parameters
organization_id
required
string <uuid>

Organization identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
data
object (PatchWorkleteAdminOrgRequest)

Responses

200

Update the organization

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

patch /worklete_admin/organizations/{organization_id}

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve course pools

path Parameters
organization_id
required
string <uuid>

Organization identifier

query Parameters
team_ids
string <uuid>

Array of team identifier

training_category_ids
string <uuid>

Array of training category identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

The team course pools

401

Unauthorized

403

Forbidden

500

Unexpected error

get /worklete_admin/organizations/{organization_id}/course_pools

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/course_pools

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/course_pools

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/course_pools

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Retrieve a list of job titles

path Parameters
organization_id
required
string <uuid>

Organization identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

A list of job titles

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

get /worklete_admin/organizations/{organization_id}/job_titles

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/job_titles

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/job_titles

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/job_titles

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

get SAML service provider metadata for Worklete Admins for an orginization

path Parameters
organization_id
required
string <uuid>

Organization identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Successfully returns metadata XML

get /worklete_admin/organizations/{organization_id}/saml_service_provider_metadata

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/saml_service_provider_metadata

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/saml_service_provider_metadata

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/saml_service_provider_metadata

Retrieve the teams

path Parameters
organization_id
required
string <uuid>

Organization identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

The teams

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

get /worklete_admin/organizations/{organization_id}/teams

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/teams

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/teams

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/teams

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Create a team

path Parameters
organization_id
required
string <uuid>

Organization identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
data
object (WorkleteAdminOrgTeam)

Responses

200

The team

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

post /worklete_admin/organizations/{organization_id}/teams

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/teams

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/teams

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/teams

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve the team

path Parameters
organization_id
required
string <uuid>

Organization identifier

team_id
required
string <uuid>

Team identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

The team identified by the team_id

401

Unauthorized

403

Forbidden

500

Unexpected error

get /worklete_admin/organizations/{organization_id}/teams/{team_id}

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/teams/{team_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/teams/{team_id}

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/teams/{team_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Update the team

path Parameters
organization_id
required
string <uuid>

Organization identifier

team_id
required
string <uuid>

Team identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
data
object (WorkleteAdminOrgTeam)

Responses

200

The team

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

patch /worklete_admin/organizations/{organization_id}/teams/{team_id}

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/teams/{team_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/teams/{team_id}

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/teams/{team_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve a lexicological list of training categories

path Parameters
organization_id
required
string <uuid>

Organization identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

A list of training categories

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

get /worklete_admin/organizations/{organization_id}/training_categories

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/training_categories

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/training_categories

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/training_categories

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Create a training categories

path Parameters
organization_id
required
string <uuid>

Organization identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
name
string

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Unexpected error

post /worklete_admin/organizations/{organization_id}/training_categories

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/training_categories

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/training_categories

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/training_categories

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "Training Category 1"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update a training category

path Parameters
organization_id
required
string <uuid>

Organization identifier

training_category_id
required
string <uuid>

Training Category identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
name
string
job_titles
Array of strings
course_ids
Array of strings <uuid>

Responses

200

A list of training categories

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

patch /worklete_admin/organizations/{organization_id}/training_categories/{training_category_id}

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/training_categories/{training_category_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/training_categories/{training_category_id}

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/training_categories/{training_category_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "Training category 1",
  • "job_titles":
    [
    ],
  • "course_ids":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Generate a signed url for the memberships list

path Parameters
organization_id
required
string <uuid>
Example: ea7876b2-e174-418f-bef8-140559860a83

Organization ID

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

A signed s3 url to upload the memberships csv. The location is based off of the s3_integrations_folder and the name of the file is randomly generated appended with .csv.

401

Unauthorized

get /worklete_admin/organizations/{organization_id}/upload_memberships_list_url

development

http://localhost:3001/api/v1/worklete_admin/organizations/{organization_id}/upload_memberships_list_url

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/organizations/{organization_id}/upload_memberships_list_url

production

https://connection.worklete.com/api/v1/worklete_admin/organizations/{organization_id}/upload_memberships_list_url

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve team refinements

path Parameters
team_id
required
string <uuid>

Team identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Refinements for the specified team_id

401

Unauthorized

403

Forbidden

500

Unexpected error

get /worklete_admin/teams/{team_id}/refinements

development

http://localhost:3001/api/v1/worklete_admin/teams/{team_id}/refinements

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/teams/{team_id}/refinements

production

https://connection.worklete.com/api/v1/worklete_admin/teams/{team_id}/refinements

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create team refinement

path Parameters
team_id
required
string <uuid>

Team identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
data
object

Responses

200

Refinements for the specified team_id

401

Unauthorized

403

Forbidden

500

Unexpected error

post /worklete_admin/teams/{team_id}/refinements

development

http://localhost:3001/api/v1/worklete_admin/teams/{team_id}/refinements

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/teams/{team_id}/refinements

production

https://connection.worklete.com/api/v1/worklete_admin/teams/{team_id}/refinements

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve team refinement

path Parameters
team_id
required
string <uuid>

Team identifier

refinement_id
required
string <uuid>

Refinement identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

Refinements for the specified team_id

401

Unauthorized

403

Forbidden

500

Unexpected error

get /worklete_admin/teams/{team_id}/refinements/{refinement_id}

development

http://localhost:3001/api/v1/worklete_admin/teams/{team_id}/refinements/{refinement_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/teams/{team_id}/refinements/{refinement_id}

production

https://connection.worklete.com/api/v1/worklete_admin/teams/{team_id}/refinements/{refinement_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update a team refinement

path Parameters
team_id
required
string <uuid>

Team identifier

refinement_id
required
string <uuid>

Refinement identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
data
object

Responses

200

Refinements for the specified team_id

401

Unauthorized

403

Forbidden

500

Unexpected error

patch /worklete_admin/teams/{team_id}/refinements/{refinement_id}

development

http://localhost:3001/api/v1/worklete_admin/teams/{team_id}/refinements/{refinement_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/teams/{team_id}/refinements/{refinement_id}

production

https://connection.worklete.com/api/v1/worklete_admin/teams/{team_id}/refinements/{refinement_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieve a list of users

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

A list of users

401

Unauthorized

403

Forbidden

500

Unexpected error

get /worklete_admin/users

development

http://localhost:3001/api/v1/worklete_admin/users

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/users

production

https://connection.worklete.com/api/v1/worklete_admin/users

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Retrieve the organization

path Parameters
user_id
required
string <uuid>

user identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Responses

200

The user

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

get /worklete_admin/users/{user_id}

development

http://localhost:3001/api/v1/worklete_admin/users/{user_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/users/{user_id}

production

https://connection.worklete.com/api/v1/worklete_admin/users/{user_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Update the user

path Parameters
user_id
required
string <uuid>

user identifier

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
data
object (PatchWorkleteAdminUserRequest)

Responses

200

Update the user

401

Unauthorized

403

Forbidden

404

Resource not found

500

Unexpected error

patch /worklete_admin/users/{user_id}

development

http://localhost:3001/api/v1/worklete_admin/users/{user_id}

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/users/{user_id}

production

https://connection.worklete.com/api/v1/worklete_admin/users/{user_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Sets a user's password. Requires worklete employee access.

header Parameters
access-token
required
string
Example: 2ouSEo2GaqzwEXftiIk1

Access token

client
required
string
Example: ZTtsKT-ZuOikXI3cqrixkg

Client is used to identify the user across multiple devices.

uid
required
string
Example: workleteuser

User identifier

Request Body schema: application/json
user_id
string <uuid>

The user's UUID to reset password

Responses

200

A successful response containing the User's ID and the new password

400

Bad Request

401

Unauthorized

500

Unexpected error

post /worklete_admin/set_password

development

http://localhost:3001/api/v1/worklete_admin/set_password

stage

https://worklete-server-stage.herokuapp.com/api/v1/worklete_admin/set_password

production

https://connection.worklete.com/api/v1/worklete_admin/set_password

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "user_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}