Get a field of research

Returns one ANZSRC 2020 field of research with its parent and children. The parameter accepts the code, slug, or title.

GET /v1/people/fields/{code}

cURL

cURL

curl -H "X-API-Key: $PARTICLE_API_KEY" \ "https://api.particle.pro/v1/people/fields/{code}"

200

{
  "code": "<string>",
  "slug": "<string>",
  "standard": "soc_2018",
  "title": "<string>",
  "children": [
    {
      "code": "<string>",
      "slug": "<string>",
      "standard": "soc_2018",
      "title": "<string>",
      "group": "minor",
      "level": 123,
      "parent_code": "<string>"
    }
  ],
  "equivalents": [
    {
      "code": "<string>",
      "slug": "<string>",
      "standard": "soc_2018",
      "title": "<string>",
      "group": "minor",
      "level": 123,
      "parent_code": "<string>"
    }
  ],
  "group": "minor",
  "level": 123,
  "parent": {
    "code": "<string>",
    "slug": "<string>",
    "standard": "soc_2018",
    "title": "<string>",
    "group": "minor",
    "level": 123,
    "parent_code": "<string>"
  },
  "parent_code": "<string>"
}

Prefer the terminal? This endpoint is also a command in the Particle CLI: pick Particle CLI in the request example’s language menu. Install the Particle CLI.

Authorizations

ApiKeyHeaderBearerAuth

X-API-Key · string · header · required

Pass your API key in the X-API-Key header (recommended).

Path Parameters

code · string · required

The field of research's ANZSRC 2020 code (320101), slug (cardiology-incl-cardiovascular-diseases), or title. A title a group shares with one of its own fields resolves to the group.

Maximum string length: 200

Response

200

application/json

OK

code · string · required

The standard's own notation, such as 29-1212 (SOC), 2212 (ISCO), or 320101 (FoR).

slug · string · required

The title as a URL segment, such as cardiologists.

standard · enum<string> · required

The standard the code belongs to: soc_2018 (US Standard Occupational Classification), isco_08 (the ILO's International Standard Classification of Occupations), or anzsrc_for_2020 (ANZSRC Fields of Research).

Available options: soc_2018, isco_08, anzsrc_for_2020

title · string · required

The standard's official title, such as Cardiologists.

children · object[] | null

Every code one level down; omitted for the most specific level. Below a SOC major group are its minor groups, below a minor group its broad groups, and below a broad group or an alias its detailed occupations.

Show child attributes

equivalents · object[] | null

The same occupation in the other occupation standard, per the official BLS SOC 2018 to ISCO-08 crosswalk: the ISCO groups a SOC occupation maps to, or the SOC occupations that map to an ISCO group. Omitted for fields of research.

Show child attributes

group · enum<string>

Set for a code that stands for several detailed SOC 2018 occupations: a SOC minor group (such as 29-1000 Healthcare Diagnosing or Treating Practitioners), a broad group (such as 29-1210 Physicians), or an alias, an everyday name such as doctors (physicians and surgeons). Every occupation filter accepts one and matches a speaker listed under any of its occupations.

Available options: minor, broad, alias

level · integer<int64>

Depth in the standard's official hierarchy: SOC major group 1 and detailed occupation 2; FoR division 1, group 2, field 3; ISCO-08 unit group 4 and minor group 3. ISCO-08 codes are the groups SOC maps to, listed flat without the standard's upper levels. Omitted for a SOC group or alias (see group).

parent · object

The code one level up as you browse, the reverse of children: a detailed SOC occupation's broad group, a broad group's minor group, a minor group's major group. Omitted at the top level and for ISCO-08 codes. parent_code keeps the standard's official parent, which for a detailed SOC occupation is its major group.

Show child attributes

parent_code · string

The standard's official parent code; omitted at the top level and for every ISCO-08 code, since ISCO-08 is listed without its upper levels. A SOC broad group's parent is its minor group and a minor group's its major group, but a detailed SOC occupation's official parent is its major group (29-1211 has parent_code 29-0000), so it can differ from parent, which is the browse parent one level up (29-1210).