Retrieve company list

Retrieve company list

get

Retrieve a company list

Authorizations

tokenAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

short_idstringRequired

Responses

200Success

application/json

idstringRead-onlyRequired

short_idstringRead-onlyRequired

namestring · max: 255Required

sourcestring · max: 255 · nullableOptional

num_optionsstringRead-onlyRequired

401

Unauthorized

404

Not found

get

v1/company/lists/{short_id}/

Python

import requests
response = requests.get(
    "https://journeys-api.50skills.app/v1/company/lists/jZzwxywD/",
)
print(response.json())
                    

{
  "id": "jZzwxywD",
  "shortId": "jZzwxywD",
  "name": "List one",
  "source": "",
  "options": [
    {
      "shortId": "8OzY2y57",
      "value": "1",
      "label": "Item 1",
      "order": 0
    },
    {
      "shortId": "AOyeZGXP",
      "value": "2",
      "label": "Item 2",
      "order": 1
    }
  ],
  "numOptions": 2
}

Request sample

Python

import requests
response = requests.get(
    "https://journeys-api.50skills.app/v1/company/lists/jZzwxywD/",
)
print(response.json())             

Response samples

200

{
   "id":"mQxg5vGb",
   "shortId":"mQxg5vKM",
   "name":"Jira issue types",
   "source":"Jira",
   "options":[
      {
         "shortId":"8VKkppzP",
         "value":"10003",
         "label":"Service request",
         "order":0
      },
      {
         "shortId":"8ob3kwzp",
         "value":"10000",
         "label":"Epic",
         "order":1
      },
      {
         "shortId":"AEGdQnKo",
         "value":"10007",
         "label":"System problem",
         "order":2
      }
   ],
   "numOptions":3
}