Directory

get

Returns a list of all people in your organization, including names, email addresses, and home addresses.

Responses

200

OK

application/jsontext/jsonapplication/xmltext/xmltext/html

Responseobject

get

/api/learners

HTTPcURLJavaScriptPython

GET /api/learners HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*

200

OK

{}

get

Returns a person using the person's unique globally unique identifier or individual account code. Account codes are alphanumeric values assigned by your organization.

Path parameters

idstringRequired

Responses

200

OK

application/jsontext/jsonapplication/xmltext/xmltext/html

Responseobject

get

/api/learners/{id}

HTTPcURLJavaScriptPython

GET /api/learners/{id} HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*

200

OK

{}

post

Updates the person's name, email address, and home address. If the person is not in the database, then this method adds them as a new person.

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

Identifierstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

FirstNamestringOptional

MiddleNamestringOptional

LastNamestringOptional

EmailstringOptional

CodestringOptional

PasswordstringOptional

IsAdministratorbooleanOptional

IsLearnerbooleanOptional

AccessGrantedstring · date-timeOptional

AccessRevokedstring · date-timeOptional

Responses

200

OK

application/jsontext/jsonapplication/xmltext/xmltext/html

Responseobject

post

/api/learners/save

HTTPcURLJavaScriptPython

POST /api/learners/save HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "Identifier": "00000000-0000-0000-0000-000000000000",
  "FirstName": "text",
  "MiddleName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text",
  "Password": "text",
  "IsAdministrator": true,
  "IsLearner": true,
  "AccessGranted": "2026-01-29T17:49:08.175Z",
  "AccessRevoked": "2026-01-29T17:49:08.175Z",
  "HomeAddress": {
    "Street1": "text",
    "Street2": "text",
    "City": "text",
    "State": "text",
    "Country": "text",
    "PostalCode": "text"
  }
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

200

OK

{}

post

Updates the person's name, email address, and home address. If the person is not in the database, then this method adds them as a new person.

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

Identifierstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

FirstNamestringOptional

MiddleNamestringOptional

LastNamestringOptional

EmailstringOptional

CodestringOptional

PasswordstringOptional

IsAdministratorbooleanOptional

IsLearnerbooleanOptional

AccessGrantedstring · date-timeOptional

AccessRevokedstring · date-timeOptional

Responses

200

OK

application/jsontext/jsonapplication/xmltext/xmltext/html

Responseobject

post

/api/learners/{id}/save

HTTPcURLJavaScriptPython

POST /api/learners/{id}/save HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "Identifier": "00000000-0000-0000-0000-000000000000",
  "FirstName": "text",
  "MiddleName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text",
  "Password": "text",
  "IsAdministrator": true,
  "IsLearner": true,
  "AccessGranted": "2026-01-29T17:49:08.175Z",
  "AccessRevoked": "2026-01-29T17:49:08.175Z",
  "HomeAddress": {
    "Street1": "text",
    "Street2": "text",
    "City": "text",
    "State": "text",
    "Country": "text",
    "PostalCode": "text"
  }
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

200

OK

{}

post

Counts the learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

FirstNamestringOptional

LastNamestringOptional

EmailstringOptional

CodestringOptional

Responses

200

OK

application/jsontext/jsonapplication/xmltext/xmltext/html

Responseobject

post

/api/learners/count

HTTPcURLJavaScriptPython

POST /api/learners/count HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "FirstName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

200

OK

{}

post

Counts the learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

FirstNamestringOptional

LastNamestringOptional

EmailstringOptional

CodestringOptional

Responses

200

OK

application/jsontext/jsonapplication/xmltext/xmltext/html

Responseobject

post

/api/learners/{id}/count

HTTPcURLJavaScriptPython

POST /api/learners/{id}/count HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "FirstName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

200

OK

{}

post

Searches for learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

FirstNamestringOptional

LastNamestringOptional

EmailstringOptional

CodestringOptional

Responses

200

OK

application/jsontext/jsonapplication/xmltext/xmltext/html

Responseobject

post

/api/learners/search

HTTPcURLJavaScriptPython

POST /api/learners/search HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "FirstName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

200

OK

{}

post

Searches for learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

FirstNamestringOptional

LastNamestringOptional

EmailstringOptional

CodestringOptional

Responses

200

OK

application/jsontext/jsonapplication/xmltext/xmltext/html

Responseobject

post

/api/learners/{id}/search

HTTPcURLJavaScriptPython

POST /api/learners/{id}/search HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "FirstName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedtext/html

200

OK

{}