WWorkStory Help Center

WorkStory API Key Integrations

API key reference for WorkStory integrations. Use your account-scoped x-api-key header; responses inherit the account’s company scope and permissions. Available endpoints: GET /api/account/ for accounts, GET /api/tree/tree for the organization tree, GET /api/company/company for company details, and GET /api/performance-review/ for performance reviews. List endpoints support bracket-notation filters and options for paging, sorting, related-object includes, and field projection.

In this article

GET/api/account/

List accounts in the caller's company. Supports filtering, paging, sorting, related-object includes, and field projection.

Filters

KeyTypeNotes
idsstring[]Restrict to specific account ids
notIdsstring[]Exclude account ids
emailsstring[]Match by email
groupsstring[]Match by group membership
groupIdstringSingle group id
reviewsstring[]Filter by review association
manageAccountsstring[]Accounts managed by given ids
status / notStatusenum[]Account status (e.g. active, unassigned)
accessenum[]Access level (e.g. Admin)
verifiedbooleanEmail verification state
settings.isArchivedbooleanArchived accounts

Options

KeyTypeNotes
page.number / page.sizeintPagination, 1-indexed
sort.field / sort.orderstring / asc|descSort column and direction
search.field / search.valuestringFree-text search; set search.enabled
include.*booleanreviewers, manager, peers, directReports, managedAccounts
projectionstring[]Limit response to named account columns

Request

curl -G 'https://app.workstory.team/api/account/' \
  -H 'x-api-key: <your_api_key>' \
  --data-urlencode 'options[page][number]=1' \
  --data-urlencode 'options[page][size]=50'

GET/api/tree/tree

Returns the full org tree for the caller's company, plus the viewer's own node, deleted nodes, and goals. No query parameters — company is resolved from the API key.

Response shape

FieldNotes
data.treeFull nested org tree
data.myTreeRowNode matching the API key's account
data.deletedRemoved nodes
data.goalsGoal data attached to the tree

Request

curl 'https://app.workstory.team/api/tree/tree' \
  -H 'x-api-key: <your_api_key>'
Note. Response body data is a JSON-encoded string, not a nested object — parse it client-side.

GET/api/company/company

Returns the caller's company record. Company is resolved from the API key — no id parameter.

Options

KeyTypeNotes
include.questionsbooleanInclude the company's question set in the response

Request

curl -G 'https://app.workstory.team/api/company/company' \
  -H 'x-api-key: <your_api_key>' \
  --data-urlencode 'options[include][questions]=true'

GET/api/performance-review/

List performance reviews in the caller's company. Supports filtering, paging, sorting, and related-object includes.

Filters

KeyTypeNotes
ids / notIdsstring[]Review id include/exclude
reviewCycleIdstringScope to one review cycle
reviewCycleStatusstring[]Filter by cycle status
revieweeIds / notRevieweeIdsstring[]Filter by reviewee
managerIdsstring[]Filter by manager
participantIdsstring[]Filter by any participant
status / notStatusenum[]Review status (e.g. Draft, Released)
groupIdsstring[]Filter by group
rolesstring[]Filter by role
selectedPeerIds / notSelectedPeerIdsstring[]Peer selection filters
selectedDirectReportIds / notSelectedDirectReportIdsstring[]Direct report selection filters
containsSubmission / notContainsSubmissionstringFilter by submission presence

Options

KeyTypeNotes
page.number / page.sizeintPagination, 1-indexed
sort.field / sort.orderstring / asc|descSort column and direction
search.field / search.valuestringFree-text search; set search.enabled
include.*booleanreviewee, manager, reviewCycle, selectedPeers, authors, targets, competencies, goals
includeAvailableFiltersbooleanReturn which filter values are applicable

Request

curl -G 'https://app.workstory.team/api/performance-review/' \
  -H 'x-api-key: <your_api_key>' \
  --data-urlencode 'filters[reviewCycleId]=abc123' \
  --data-urlencode 'filters[status][]=DRAFT' \
  --data-urlencode 'options[page][number]=1' \
  --data-urlencode 'options[page][size]=25' \
  --data-urlencode 'options[include][reviewee]=true' \
  --data-urlencode 'options[include][manager]=true'

x-api-key resolves to an account · company scope and permissions follow that account

Still need help?

Contact the WorkStory team if your question is not covered in this guide.

Contact support