Job Positions API - ApyHub

Job Positions API

Data Extraction#extract#text
SharpAPI
SharpAPI
verified icon
1000 atoms
Base tier

About

The Job Positions API provides structured access to a vast database of job positions across industries. This API allows you to search for job roles by name, retrieve paginated lists, and explore related job positions with relevancy weights. It's a powerful tool for HR platforms, job boards, AI-driven career matching, and workforce analytics.

Key Features and Capabilities

Structured Data Access:
The API offers detailed information on job positions, including related roles with weighted relevancy scores. This means you can quickly identify connections between roles, helping you streamline career matching or expand your job listings with confidence.
Targeted Search and Filtering:
Utilize parameters to filter job roles by name, allowing you to narrow down your queries and retrieve precise results. With paginated data retrieval, managing large datasets becomes a breeze.
Integration Ready:
Designed to integrate seamlessly with your existing systems, the Job Positions API serves as a powerful tool for:
  • HR Platforms & Job Boards: Enhance user experience by providing accurate, up-to-date job information.
  • AI-Powered Career Matching: Leverage structured data for advanced algorithms to match candidates with suitable roles.
  • Workforce Analytics: Gain insights into market trends and job role relationships, aiding strategic HR decisions.

API Playground

API Documentation

list-job positions
GET
https://api.apyhub.com/sharpapi/api/v1/utilities/job_positions_list

Request example

1
```cURL
2


3
curl --location --request GET 'https://api.apyhub.com/sharpapi/api/v1/utilities/job_positions_list' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
Accessing the Job Positions API is straightforward. Use the following endpoint with a simple GET request:
Method: GET
Content Type: application/json
Query Parameter(s)
AttributeTypeMandatoryDescription
include_relatedBooleanNoIf true, includes related skills with their relevancy weights. Default is false.
per_pageIntegerNoSpecifies the page number for paginated results. Default is 1.
nameStringNoFilters skills by name (partial match allowed).
The API responds with structured JSON data, clearly organizing job roles and their related positions for seamless integration.
Sample Response
1
{
2
    "data": [
3
        {
4
            "id": "18f73cda-db62-454b-aa53-aa26acb196b7",
5
            "name": "Billing Manager",
6
            "slug": "billing-manager",
7
            "related_job_positions": [
8
                {
9
                    "id": "445b1023-2c3c-41c4-a986-08d8400e52a5",
10
                    "name": "Accounts Receivable Manager",
11
                    "slug": "accounts-receivable-manager",
12
                    "weight": 9
13
                },
14
                {
15
                    "id": "f6749359-de3a-4c32-ac31-75e059197a0f",
16
                    "name": "Billing Coordinator",
17
                    "slug": "billing-coordinator",
18
                    "weight": 8
19
                },
20
                {
21
                    "id": "0af1d5f1-e70c-4560-a95e-f9db52c8afd1",
22
                    "name": "Billing Administrator",
23
                    "slug": "billing-administrator",
24
                    "weight": 5
25
                },
26
                {
27
                    "id": "bd8f8374-a717-4474-be41-5582a67b4ff9",
28
                    "name": "Billing Supervisor",
29
                    "slug": "billing-supervisor",
30
                    "weight": 9.5
31
                }
32
            ]
33
        },
34
        {
35
            "id": "d766ba1d-c03a-4081-9cdf-75aa05de8b46",
36
            "name": "Accounts Payable Specialist",
37
            "slug": "accounts-payable-specialist",
38
            "related_job_positions": [
39
                {
40
                    "id": "8ff7aa21-e337-4a27-82f6-7d4e04be7125",
41
                    "name": "Accounts Payable Clerk",
42
                    "slug": "accounts-payable-clerk",
43
                    "weight": 9.5
44
                },
45
                {
46
                    "id": "c9b48a4b-358d-4524-a62e-90b6164d9dcd",
47
                    "name": "Accounts Payable Administrator",
48
                    "slug": "accounts-payable-administrator",
49
                    "weight": 8.5
50
                }
51
            ]
52
        }
53
    ],
54
    "links": {
55
        "first": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=1",
56
        "last": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=1103",
57
        "prev": null,
58
        "next": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=2"
59
    },
60
    "meta": {
61
        "current_page": 1,
62
        "from": 1,
63
        "last_page": 1103,
64
        "links": [
65
            {
66
                "url": null,
67
                "label": "« Previous",
68
                "active": false
69
            },
70
            {
71
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=1",
72
                "label": "1",
73
                "active": true
74
            },
75
            {
76
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=2",
77
                "label": "2",
78
                "active": false
79
            },
80
            {
81
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=3",
82
                "label": "3",
83
                "active": false
84
            },
85
            {
86
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=4",
87
                "label": "4",
88
                "active": false
89
            },
90
            {
91
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=5",
92
                "label": "5",
93
                "active": false
94
            },
95
            {
96
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=6",
97
                "label": "6",
98
                "active": false
99
            },
100
            {
101
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=7",
102
                "label": "7",
103
                "active": false
104
            },
105
            {
106
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=8",
107
                "label": "8",
108
                "active": false
109
            },
110
            {
111
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=9",
112
                "label": "9",
113
                "active": false
114
            },
115
            {
116
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=10",
117
                "label": "10",
118
                "active": false
119
            },
120
            {
121
                "url": null,
122
                "label": "...",
123
                "active": false
124
            },
125
            {
126
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=1102",
127
                "label": "1102",
128
                "active": false
129
            },
130
            {
131
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=1103",
132
                "label": "1103",
133
                "active": false
134
            },
135
            {
136
                "url": "https://apyhub.com/api/v1/utilities/job_positions_list?include_related=true&page=2",
137
                "label": "Next »",
138
                "active": false
139
            }
140
        ],
141
        "path": "https://apyhub.com/api/v1/utilities/job_positions_list",
142
        "per_page": 15,
143
        "to": 15,
144
        "total": 16544
145
    }
146
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles