Skip to main content

​
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.

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

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

Users

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

​
Scope Selection Best Practices

Principle of Least Privilege: Only request the scopes your application actually needs. This improves security and makes your integration more focused.

​
Common Scope Combinations

Recommended scopes: Jobs, CompaniesPerfect for displaying job listings and company information on external job boards or career sites.
Recommended scopes: Jobs, ApplicantsIdeal for building ATS integrations that need to manage the full hiring pipeline.
Recommended scopes: All scopesComprehensive access for full HR platform integrations that manage all aspects of hiring.
Recommended scopes: Jobs, Applications, OrganizationsGreat for creating reporting and analytics tools that track hiring metrics.

​
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
Important: API requests will fail with a 403 Forbidden error if your token lacks the required scope for the endpoint you’re trying to access.