Skip to main content
GET
Get all occupations

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

search
string | null

The search query matched against the occupation name.

Maximum string length: 255
is_active
boolean | null

Restrict the result to active or inactive occupations.

is_global
boolean | null

Restrict the result to the system-wide catalog (true) or the tenant's own occupations (false).

per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1
sort_by
enum<string> | null

The field to sort by.

Mevcut seçenekler:
name,
customers_count,
created_at,
updated_at,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null
created_at_from
string<date-time> | null

The earliest creation date to include.

created_at_to
string<date-time> | null

The latest creation date to include.

Yanıt

Paginated set of OccupationResource

data
OccupationResource · object[]
gerekli
meta
object
gerekli