Skip to main content

Marty Customer API

Marty API scopes control secure access.

Updated over 2 weeks ago

Use the Marty API to programmatically retrieve or modify data in your account, and to build custom integrations with your HR stack.

Understanding API Scopes

When integrating with the API, it's essential to understand scopes—they define what data the token can access. In Marty, scopes ensure secure and intentional access to only the resources you authorize.

Available Scopes

  • Read Assessments
    Allows reading assessment data and related details.

  • Invite Candidates
    Grants access to invite candidates to assessments.

  • Manage Candidate Surveys
    Enables reading surveys and sending them to candidates.

  • View Candidate Survey Reports
    Lets you access survey feedback and reporting.

  • Manage AI Screening
    Allows configuration and control of AI-driven candidate evaluations.

How to Generate an API Token

  1. Go to: Profile → Settings → API Tokens

  2. Step 1: Give your token a label and select the appropriate scopes.

  3. Step 2: Copy your token immediately after it’s generated—you won't be able to view it again later.

Conclusion

Scopes are a critical security layer when using the Marty API.
By choosing the right scopes, you ensure the token only has access to the data it needs—nothing more, nothing less. Always apply the principle of least privilege when creating tokens.

API Endpoint

Swagger documentation (interactive API explorer):
👉 https://api.marty.hr/swagger/index.html?urls.primaryName=Customers+API

Did this answer your question?