Generating a typed client

Two specs are available:

1. The curated spec (recommended)

The spec that powers this documentation site — hand-maintained, with descriptions and examples:

https://docs.partners.thecareeros.com/openapi/careeros-partners-v1.yaml

Feed it to openapi-generator:

openapi-generator-cli generate \
  -i https://docs.partners.thecareeros.com/openapi/careeros-partners-v1.yaml \
  -g typescript-axios \
  -o ./careeros-partner-client

Generators exist for TypeScript, Python, Go, Java, Swift, C#, PHP, Ruby, and more (-g python, -g go, …).

2. The live spec

The API also serves a machine-generated spec at runtime, reflecting exactly what your token can access:

curl -H "Authorization: Bearer $TOKEN" https://api.partners.thecareeros.com/v1/ | jq

The live spec updates the moment we ship new columns or resources — useful for diffing what changed. It has no prose or examples, so prefer the curated spec for codegen and this site for reading.

Notes

• Filters (?field=eq.value) are query-string conventions, not typed parameters — generated clients expose them as free-form query params. Keep a small helper for building them.
• Clients should ignore unknown response fields: we add columns without notice (that’s the v1 compatibility promise).