Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

List published openings or explicitly inspect revisions

GET/v1/organizations/{orgId}/openings
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault TEST service token) · headerrequired

Customer- and resource-bound service grant, rechecked on every call. Existing Live opening-feed authority remains narrow; ordinary Test business requests refuse until shared Test composition is available.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

Organization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Query parameters
cursorstring
min length 1 · max length 2048
limitinteger
min 1 · max 100 · default: 50
includeRevisionsboolean | string
default: false
Responses
200

Success

dataobject[]required
Show properties
Array of object
deletedbooleanrequired
publishedbooleanrequired
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
openingRefstringrequired
min length 1
recordedAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
revisionintegerrequired
max 9007199254740991
rowsobject[]required
Show properties
Array of object
assessedConditionstringrequired
Allowed:dmghplpmpnmno_damage_found
baseSkuSnapshotstring | null
Show properties
Any of:
string
string
null
null
externalCatalogRefstringrequired
min length 1
positionintegerrequired
max 9007199254740991
productBindingIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
providerSkuSnapshotstring | null
Show properties
Any of:
string
string
null
null
serialobject | null
Show properties
Any of:
object
numberintegerrequired
min 1 · max 9999
runintegerrequired
min 1 · max 9999
null
null
variantBindingIdstring | nullrequired
Show properties
Any of:
string
string
null
null
supplyPurchaseOrderIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
metaobjectrequired
Show properties
requestIdstringrequired
nextCursorstring | nullrequired
previousCursorstring | nullrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X GET '/v1/organizations/string/openings' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "deleted": true,
      "published": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "openingRef": "string",
      "recordedAt": "2019-08-24T14:15:22Z",
      "revision": 1,
      "rows": [
        {
          "assessedCondition": "dmg",
          "baseSkuSnapshot": "string",
          "externalCatalogRef": "string",
          "position": 1,
          "productBindingId": "string",
          "providerSkuSnapshot": "string",
          "serial": {
            "number": 1,
            "run": 1
          },
          "variantBindingId": "string"
        }
      ],
      "supplyPurchaseOrderId": "string"
    }
  ],
  "meta": {
    "requestId": "string",
    "nextCursor": "string",
    "previousCursor": "string"
  }
}

Was this page helpful?