API Scopes

​

Overview

API scopes control which resources your token can access. When creating an API token, you can select one or more scopes to limit the permissions granted to your application.

​

Available Scopes

1. Users
2. Jobs
3. Applications
4. Companies
5. Applicants
6. Organizations
7. Webhooks

​

Jobs

Access job postings and job-related data

• Create, read, update, and delete job postings
• Manage job status and visibility
• Access job analytics and metrics

​

Applications

Manage job applications and application flow

• View and update application statuses
• Access application data and candidate responses
• Handle application workflows and processes

​

Companies

Manage company profiles and information

• Create and update company profiles
• Access company details and branding
• Manage company settings and preferences

​

Applicants

Manage applicant profiles and data

• Access applicant information
• View applicant resumes and profiles
• Manage applicant communications

​

Organizations

Access organization-level data and settings

• Manage organization structure and hierarchy
• Access organization-wide analytics and reports
• Handle organization settings and configurations

​

Webhooks

Manage webhook endpoints and events

• Create, update, and delete webhook endpoints
• Configure event subscriptions
• Monitor webhook delivery and status

​

Users

Manage user accounts and permissions

• Create and update user profiles
• Manage user roles and permissions
• Handle user authentication settings

​

Scope Selection Best Practices

​

Common Scope Combinations

​

Managing Scopes

​

Token Creation

When creating a new API token in your Hirempire API Tokens page:

1. Select the required scopes for your use case
2. Set an appropriate expiry date
3. Save the token securely

​

Scope Limitations

• Tokens are limited to the scopes selected during creation
• You cannot expand scopes for existing tokens
• Create a new token if you need additional permissions