CandidateDocument

Find all candidate document.

GET

http://localhost:3000/api/candidate-documents

curl -X GET 'http://localhost:3000/api/candidate-documents' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('http://localhost:3000/api/candidate-documents', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'http://localhost:3000/api/candidate-documents',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "name": "string",
  "documentUrl": "string",
  "candidate": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "rating": 0,
    "valueDate": "2024-01-15T09:30:00Z",
    "appliedDate": "2024-01-15T09:30:00Z",
    "hiredDate": "2024-01-15T09:30:00Z",
    "rejectDate": "2024-01-15T09:30:00Z",
    "status": "APPLIED",
    "candidateLevel": "string",
    "reWeeklyLimit": 0,
    "billRateCurrency": "USD",
    "billRateValue": 0,
    "minimumBillingRate": 0,
    "payPeriod": "WEEKLY",
    "cvUrl": "string",
    "contactId": "string",
    "organizationPositionId": "string",
    "sourceId": "string",
    "userId": "string",
    "employeeId": "string"
  },
  "candidateId": "string"
}

Parameters

selectObjectquery

relationsObjectquery

whereObjectrequiredquery

orderObjectquery

withDeletedbooleanquery

takenumber[0, 100]query

skipnumber>= 0query

Response

200OKCandidateDocument

Found candidate document

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

documentUrlstring

candidateCandidate

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

ratingnumber

valueDatestring<date-time>

appliedDatestring<date-time>

hiredDatestring<date-time>

rejectDatestring<date-time>

statusstringAPPLIEDREJECTEDHIRED

candidateLevelstring

reWeeklyLimitnumber

billRateCurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL

Example

USD

billRateValuenumber

minimumBillingRatenumber

payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLY

Example

WEEKLY

cvUrlstring

contactIdstring

organizationPositionIdstring

sourceIdstringrequired

userIdstringrequired

employeeIdstringrequired

candidateIdstringrequired

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Record not found

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo