Show All Candidate

GET

GET

http://api.atzcrm.com/v1/candidate

Retrieve the details of all candidate.

Request

GET

GET /v1/candidate

Query Parameter

• sortOrderinteger

  Field to sort by (e.g., first_name, last_name, created_at).

• sortByColumninteger

  Sort order (asc for ascending, desc for descending).

• pageinteger

  The page number for pagination.

• limitinteger

  Number of candidates per page.

• 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/candidate?maximize=owner,currency,industry

Response

200

Body

• idnumber

  Example: 48

• first_namestring

  Example: John

• last_namestring

  Example: Doe

• slugstring

  Example: candidate_0d25558c1a77fc2d7d98

• full_namestring

  Example: John Doe

• emailstring

  Example: johndoe@example.com

• phonestring

  Example: 1234567890

• resumestring

  Example: resume.pdf

• profile_picturestring

  Example: anjali.jpg

• education_specializationstring

  Example: Computer Science

• universitystring

  Example: Harvard University

• current_positionstring

  Example: Software Engineer

• current_organizationstring

  Example: XYZ Inc

• last_organizationstring

  Example: ABC Corp

• willing_to_relocatenumber

  Example: 0

• available_fromstring

  Example: 2024-09-01

• tagsstring

  Example: [frontend, developer, javascript]

• skillstring

  Example: [JavaScript, React]

• experiencenumber

  Example: 5

• graduation_datestring

  Example: 2015-05-15

• current_salarynumber

  Example: 70000

• expected_salarynumber

  Example: 90000

• notice_periodnumber

  Example: 30

• salary_typeinteger

  Example: 1

• descriptionstring

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

• sourcestring

  Example: LinkedIn

• nationalitystring

  Example: American

• addressstring

  Example: 123 Main St

• languagestring

  Example: Hindi

• citystring

  Example: Indore

• statestring

  Example: Madhya Pradesh

• countrystring

  Example: USA

• industryinteger

  Example: 1

• genderobject

  Example:
  "id": 1,
  "label": "female"

• ownerobject

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

• currencyobject

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

• qualificationstring

  Example: btech

• socialsobject

  Example:
  "linked_in": "https://www.linkedin.com/in/johndoe",
  "xing": "https://www.xing.com/profile/John_Doe"

• 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

• custom fields:object

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

401

Error

• unauthorized

Response Example

{
    "id": 51,
    "first_name": "Jo",
    "last_name": "Doe",
    "slug": "candidate_732999f1fc491eebbed0",
    "full_name": "Jo Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "resume": "",
    "profile_picture": "",
    "education_specialization": "",
    "university": "",
    "current_position": "",
    "current_organization": "",
    "last_organization": "",
    "willing_to_relocate": 0,
    "available_from": null,
    "tags": "",
    "skill": "",
    "experience": 5,
    "graduation_date": null,
    "current_salary": 0,
    "expected_salary": 80000,
    "notice_period": 1,
    "salary_type": null,
    "description": "",
    "source": "",
    "nationality": "",
    "address": "123 Main St, Anytown, USA",
    "language": "",
    "city": "Anytown",
    "state": "NY",
    "country": "USA",
    "industry": 0,
    "gender": {
        "id": 0,
        "label": "Not Available"
    },
    "owner": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "currency": {
        "id": 1,
        "country": "Albania",
        "code": "ALL",
        "currency": "Leke",
        "symbol": "Lek"
    },
    "qualification": 0,
    "socials": {
        "linkedin": "",
        "xing": ""
    },
    "created_at": "2024-08-23T16:51:23.000Z",
    "updated_at": "2024-08-23T16:51:51.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
    },
    "custom_fields": [
        {
            "id": 1,
            "field_name": "C Text asasa",
            "field_type": "text",
            "value": "Some custom value"
        },
        {
            "id": 2,
            "field_name": "C Date",
            "field_type": "date",
            "value": null
        }
    ]
}