Skip to main content
GET
/
public
/
v1
/
companies
/
{companyId}
/
employees
List a company's employees
curl --request GET \
  --url https://app.stairoids.com/api/public/v1/companies/{companyId}/employees \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "person": {
        "publicIdentifier": "jane-doe-123",
        "name": "Jane Doe",
        "headline": "VP of Marketing",
        "linkedInUrl": "<string>",
        "profilePicture": "<string>"
      },
      "email": "<string>"
    }
  ],
  "page": 0,
  "size": 20,
  "totalElements": 137,
  "totalPages": 7
}

Authorizations

​
X-Api-Key
string
header
required

Your organization's public API key.

Path Parameters

​
companyId
integer<int64>
required

Query Parameters

​
page
integer<int32>
default:0
​
size
integer<int32>
default:20

Response

OK

A page of results.

​
data
object[]

The items on this page.

​
page
integer<int32>

Zero-based page index.

Example:

0

​
size
integer<int32>

Requested page size.

Example:

20

​
totalElements
integer<int64>

Total number of matching items across all pages.

Example:

137

​
totalPages
integer<int32>

Total number of pages.

Example:

7