Goodstack Employees API
The Employees API from Goodstack — 1 operation(s) for employees.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/goodstack:goodstack-employees-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Goodstack Services Employees API
version: v1
x-logo:
url: https://docs.goodstack.io/img/logo.png
altText: Goodstack logo
x-dark-logo:
url: https://docs.goodstack.io/img/icons/Logo-white.svg
altText: Goodstack logo
contact:
email: engineering-support@goodstack.io
name: Api support
description: '# Introduction
Goodstack API allows you to build good into your product by facilitating charitable donations. We achieve this through the API''s listed and specified in this documentation. For all donations using the Goodstack API, Goodstack handles the vetting and validation of the good causes and onward the disbursement of the donation. The Goodstack API is organised around REST. All API responses, including errors, return JSON and use standard HTTP response codes. In all API requests you must specify the content-type HTTP header as application/json. All API requests must be made over HTTPS. # Authentication
Authenticate your API requests by setting your live secret API key in the Authorization header. Two keys are provided to you, a publishable key prefixed with `pk_` and a secret key prefixed with `sk_`. Publishable API keys are meant solely to identify your goodstack account. These can safely be published in places like your JavaScript code, or in an Android or iPhone app and are meant for usage with our SDKs. Secret API keys should be kept confidential and only used in secure server environments. Anywhere that accepts a Publishable key will also accept a Secret key, but routes marked to accept a Secret key will not accept a Publishable key. # Formats
## IDs
All ID fields are case-sensitive. For example, `abc123` and `ABC123` are treated as different IDs. ## Dates
Dates are encoded as strings following the ISO 8601 standard `2025-08-01T12:00:00.000Z`. ## Pagination
A maximum of 100 objects can be returned per request and the limit can be specified by using the pageSize query parameter. By default, the pageSize is set to 25. A `_links` object is included in paginated responses, which contains `next` and `prev` URLs to retrieve the next or previous pages of results. ## Monetary Values
Throughout the API, monetary values are encoded as integers representing the amount in the smallest currency unit, for example 100 cents for a donation of $1.00. Currency is encoded as a string following the ISO 4217 standard (e.g. `USD`). ## Metadata
Some objects have a metadata parameter that you can use to store key-value data. You can specify up to 20 keys, with key names up to 40 characters long and values up to 250 characters long. ## Errors
The API returns standard HTTP response codes to indicate success or failure of API requests. Errors may include a custom error message. Error objects have these attributes, an `id`, a `message` corresponding to the HTTP response phrase of the error,
an optional `invalid-params` attribute detailing issues with the request. An example error object returned from the API:
```json
{
error: {
code: ''bad_request'',
title: ''Bad request'',
message: ''Something is wrong with your request, please check any parameters and try again'',
reasons: [''amount is a required field'']
}
}
```
A summary of the HTTP status codes returned from the api is listed in the table below. | Code | Title | Description |
| ------------- |-------------| -----|
| 200 | Success | Request successful |
| 204 | No Content | Request successful with no content returned |
| 400 | Bad Request | Request was invalid |
| 401 | Unauthorised | Authorization header is invalid |
| 403 | Forbidden | Insufficient permissions |
| 404 | Not Found | Resource does not exist |
| 429 | Too Many Requests | Rate Limited |
| 500s | Internal Server Error | Something went wrong with the Goodstack API |
# Enum Values
Generally enum fields in our API are open-ended. New values may be added to an enum and this is not considered a breaking change. ## Integrating safely
If your code handles enum values exhaustively — for example, a switch without a default case, or deserialisation into a strict typed enum — an unrecognised value may cause errors. We recommend adding a fallback handler for unknown enum values, so that any new value that does reach your integration degrades gracefully rather than failing.'
servers:
- url: https://api.goodstack.io
description: Production server
- url: https://sandbox-api.goodstack.io
description: Sandbox server
tags:
- name: Employees
paths:
/v1/giving/profiles:
get:
security:
- SecretApiKey: []
summary: List Workplace Giving Employee Profiles
tags:
- Employees
parameters:
- name: sortBy
in: query
description: Sort by field
required: false
schema:
type: string
enum:
- updatedAt
example: updatedAt
- name: updatedFrom
in: query
description: Filter by updated at greater than or equal to
required: false
schema:
type: string
format: date-time
example: '2025-01-15T12:00:00.000Z'
- name: updatedTo
in: query
description: Filter by updated at less than
required: false
schema:
type: string
format: date-time
example: '2025-01-15T12:00:00.000Z'
- in: query
name: pageSize
required: false
schema:
type: integer
minimum: 1
default: 25
maximum: 100
description: How many items per page, for pagination.
- in: query
name: expand
schema:
type: string
enum:
- profileData
example: profileData
description: If provided it will attach profile data to the response
- $ref: '#/components/parameters/direction'
- $ref: '#/components/parameters/cursor'
responses:
'200':
description: Successfully retrieved a list of Workplace Giving Employees
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
description: Profile account configuration id of the employee
example: givingaccountconfig_xxxxxxxxx
minLength: 1
maxLength: 255
accountId:
type: string
description: Account id of the employee used as an identifier for the account throughout the Goodstack API
example: account_xxxxxxxxx
minLength: 1
maxLength: 255
employeeId:
type:
- string
- 'null'
description: Employee ID (or employee number) from your system to identify the employee
example: employee-12345
minLength: 1
maxLength: 255
currencyCode:
type:
- string
- 'null'
format: ISO-4217
title: ISO 4217 Currency Code
description: Currency associated with the account
example: AUD
minLength: 3
maxLength: 3
createdAt:
type: string
format: date-time
description: When the employee profile was created
example: '2025-01-01T12:00:00.000Z'
updatedAt:
type: string
format: date-time
example: '2025-01-15T12:00:00.000Z'
deletedAt:
type:
- string
- 'null'
format: date-time
example: '2025-01-15T12:00:00.000Z'
profileData:
type:
- object
- 'null'
description: String key-value associated with the employee, only included if expand=profileData is set. The keys are specific to your integration, please reach out to support if you need further information.
example:
department: Engineering
object:
type: string
example: giving_profile
pageSize:
type: integer
example: 25
_links:
$ref: '#/components/schemas/CursorLinks'
'400':
$ref: '#/components/responses/IncorrectParams'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/ForbiddenScope'
operationId: getV1GivingProfiles
x-operation-id-source: derived
components:
parameters:
direction:
in: query
name: direction
required: false
schema:
type: string
enum:
- ASC
- DESC
description: Which way to sort by the given 'sort' field. Default DESC
cursor:
in: query
name: cursor
required: false
schema:
type: string
example: eyJ2IjoxLCJkIjoibmV4dCIsImlkIjoiZG9uYXRpb25fMDAwMDAwQnc3U1BhMHBxOHBRMFFsckVaWGFaN3AifQ%3D%3D
description: A cursor that points to where to start the page
responses:
IncorrectParams:
description: Error validating inputs
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: bad_request
title:
type: string
example: Bad request
message:
type: string
example: One or more of the inputs were invalid
reasons:
type: array
items:
type: string
example: pageSize must be greater than or equal to 0
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: unauthorized
title:
type: string
example: Unauthorized
message:
type: string
example: Access is denied due to invalid credentials
ForbiddenScope:
description: Forbidden (scope)
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: forbidden
title:
type: string
example: Forbidden
message:
type: string
example: Access is denied due to missing scope permissions
schemas:
CursorLinks:
type: object
properties:
current:
type: string
example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D
next:
type: string
example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D
prev:
type: string
example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D
securitySchemes:
PublishableApiKey:
type: apiKey
in: header
name: Authorization
description: API key starting with 'pk_' that can be made public
SecretApiKey:
type: apiKey
in: header
description: API key starting with 'sk_' that must be kept secure
name: Authorization
DonationSessionToken:
type: apiKey
in: header
name: donation-session-token
description: Donation session token
SCIMBearer:
type: http
scheme: bearer
description: 'SCIM API key issued for the partner, presented as a bearer token in the
`Authorization` header. The key is bound to a single partner and the
partner must have the `scim_api` scope enabled. A missing or invalid key
returns `401`; a valid key for a partner without the scope also returns
`401` (`detail: "scim feature not enabled for this partner"`).
'
x-tagGroups:
- name: NONPROFIT DATA
tags:
- Organisations
- Countries
- Registries
- Categories
- Organisation Branding
- name: NONPROFIT VALIDATIONS
tags:
- Validation Requests
- Validation Request Documents
- Validation Invites
- Validation Submissions
- Validation Submission Documents
- Validation Submission Configuration
- Monitoring Subscriptions
- Eligibility Subscriptions
- Activities
- Agent Verifications
- name: MONETARY DONATIONS
tags:
- Donations
- Donation Sessions
- Users
- Gift Aid
- Monetary Donation Verifications
- name: WORKPLACE GIVING
tags:
- Employees
- Giving Donations
- Donation Match Request
- Fundraising
- Volunteering
- Gamification
- Campaigns
- Budgets
- Donation Wallets
- name: WEBHOOK SUBSCRIPTIONS
tags:
- Webhook Subscriptions
- name: WEBHOOK EVENTS
tags:
- Agent Verification Events
- Country Compliance Check Events
- Donation Events
- Eligibility Subscription Events
- Monitoring Subscription Events
- Validation Request Events
- Validation Submission Events
- Monetary Donation Verification Events
x-provenance:
method: harvested
publisher: Goodstack
source: https://reference.poweredbypercent.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)