Skip to content
API Reference/
/
career_orgs_companies_use...

ibl-data-manager (4.84.1-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

analytics

Operations

career

Operations

career_orgs_companies_users_create

Request

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
Body
required
namestring<= 100 charactersrequired
industrystring or null<= 100 characters
websitestring or null(uri)<= 255 characters
logo_urlstring or null(uri)<= 255 characters
dataany or null

Metadata

metadataany or null

Metadata

created_atstring(date-time)
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/career/orgs/{org}/companies/users/{username}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "industry": "string",
    "website": "http://example.com",
    "logo_url": "http://example.com",
    "data": null,
    "metadata": null,
    "created_at": "2019-08-24T14:15:22Z"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
userinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

user_infoobjectread-onlyrequired
user_info.​user_idintegerrequired
user_info.​usernamestring or nullrequired
user_info.​emailstring or null(email)required
user_info.​namestringrequired
user_info.​is_activeboolean
Default true
user_info.​last_activestring(date-time)
user_info.​date_joinedstring(date-time)
namestring<= 100 charactersrequired
industrystring or null<= 100 characters
websitestring or null(uri)<= 255 characters
logo_urlstring or null(uri)<= 255 characters
dataany or null

Metadata

metadataany or null

Metadata

created_atstring(date-time)
updated_atstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "user": 2147483647,
  "user_info": {
    "user_id": 0,
    "username": "string",
    "email": "user@example.com",
    "name": "string",
    "is_active": true,
    "last_active": "2019-08-24T14:15:22Z",
    "date_joined": "2019-08-24T14:15:22Z"
  },
  "name": "string",
  "industry": "string",
  "website": "http://example.com",
  "logo_url": "http://example.com",
  "data": null,
  "metadata": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

career_orgs_companies_users_update

Request

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
Body
required
namestring<= 100 charactersrequired
industrystring or null<= 100 characters
websitestring or null(uri)<= 255 characters
logo_urlstring or null(uri)<= 255 characters
dataany or null

Metadata

metadataany or null

Metadata

created_atstring(date-time)
curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/career/orgs/{org}/companies/users/{username}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "industry": "string",
    "website": "http://example.com",
    "logo_url": "http://example.com",
    "data": null,
    "metadata": null,
    "created_at": "2019-08-24T14:15:22Z"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
userinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

user_infoobjectread-onlyrequired
user_info.​user_idintegerrequired
user_info.​usernamestring or nullrequired
user_info.​emailstring or null(email)required
user_info.​namestringrequired
user_info.​is_activeboolean
Default true
user_info.​last_activestring(date-time)
user_info.​date_joinedstring(date-time)
namestring<= 100 charactersrequired
industrystring or null<= 100 characters
websitestring or null(uri)<= 255 characters
logo_urlstring or null(uri)<= 255 characters
dataany or null

Metadata

metadataany or null

Metadata

created_atstring(date-time)
updated_atstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "user": 2147483647,
  "user_info": {
    "user_id": 0,
    "username": "string",
    "email": "user@example.com",
    "name": "string",
    "is_active": true,
    "last_active": "2019-08-24T14:15:22Z",
    "date_joined": "2019-08-24T14:15:22Z"
  },
  "name": "string",
  "industry": "string",
  "website": "http://example.com",
  "logo_url": "http://example.com",
  "data": null,
  "metadata": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

career_orgs_companies_users_destroy

Request

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/career/orgs/{org}/companies/users/{username}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com