Get Job

GET

GET

https://api.atzcrm.com/v1/job/:slug

Retrieve the details of a specific job by their unique slug.

Request

GET

GET /v1/job/:slug

Path Parameter

• slugstring

  Replace :slug with the job's unique slug in the request URL.

Query Parameter

• Maximizestring

  The maximize parameter allows you to specify which items to maximize in your API response.It is comma separated string values. The following values are allowed:

  • owner
  • currency
  • created_by
  • updated_by
  • qualification
  • industry

  Note: To maximize all the items in the response, you can pass 'all' as the value for the maximize query parameter.

  Example usage:

  GET /v1/job/:slug?maximize=owner,qualification,industry

Response

200

Body

• idnumber

  Example: 19

• position_namestring

  Example: SS

• headcountnumber

  Example: 1

• slugstring

  Example: job_82f997b417b262392261

• tagsstring

  Example: [frontend, developer, javascript]

• descriptionstring

  Example: Experienced software engineer with a focus on frontend development.

• currencyobject

  Example:
  "id": 1,
  "country": "usa",
  "code": "ALL",
  "currency": "dollar",
  "symbol": "$"

• talent_funnel_idinteger

  Example: 3

• contract_details_idinteger

  Example: 1

• minimum_salarynumber

  Example: 0

• maximum_salarynumber

  Example: 0

• countrystring

  Example: india

• frequency_typeinteger

  Example: 1

• categorystring

  Example: web designing

• qualificationobject

  Example:
  "id": 1,
  "name": "btech",
  

• specializationstring

  Example: Artificial intelligence

• industryobject

  Example:
  "id": 1,
  "name": "btech",
  

• open_datestring

  Example: 1990-04-04

• close_datestring

  Example: 1990-04-04

• citystring

  Example: rewa

• statestring

  Example: M.P.

• addressstring

  Example: pipariya

• skillsstring

  Example:[java,php]

• collaboratorsobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• job_statusobject

  Example:
  "id": 1,
  "label": "open",
  

• organizationsobject

  Example:
  "id": 1

• contactsobject

  Example:
  "id": 1

• created_atstring (ISO 8601 date)

  Example: 2015-05-15T00:00:00Z

• updated_atstring (ISO 8601 date)

  Example: 2015-05-15T00:00:00Z

• created_byobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• updated_byobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• owner_idobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• custom fields:object

  Example:
  "id": 1,
  "field_name": "textfeild",
  "field_type": "string",
  "value": "anjali"

404

Error

• Job does not found

Response Example

{
    "id": 12,
    "position_name": "Test job for custommfields ",
    "headcount": 1,
    "slug": "job_2433eb46dd7056e36998",
    "tags": "java,python,c,c++",
    "description": "<p>desc </p>",
    "currency": null,
    "talent_funnel_id": 3,
    "contract_details_id": 1,
    "minimum_salary": 0,
    "maximum_salary": 0,
    "country": "",
    "frequency_type": 1,
    "category": "",
    "qualification": {
        "id": 1
    },
    "specialization": "",
    "industry": null,
    "open_date": "",
    "close_date": "",
    "city": "",
    "state": "",
    "address": "",
    "skills": "java,python,c,c++,dot net",
    "collaborators": [
        {
            "id": 1,
            "email": "Rohan@abc.com",
            "first_name": "Rohan",
            "last_name": "Sharma",
            "full_name": "Rohan Sharma",
            "role": "Admin",
            "phone": null
        }
    ],
    "job_status": {
        "id": 1,
        "label": "Open"
    },
    "organization": {
        "id": 5
    },
    "contact": {
        "id": 8
    },
    "created_at": "2024-06-27T17:43:17.000Z",
    "updated_at": "2024-06-28T01:05:34.000Z",
    "created_by": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "updated_by": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "owner_id": {
         "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "custom_fields": [
        {
            "id": 1,
            "field_name": "Job DD",
            "field_type": "dropdown",
            "value": "2"
        }
    ]
}