Skip to main content
GET
/
api
/
Documents
/
Types
/
Entity
/
{entityId}
Get document types by entity ID.
curl --request GET \
  --url https://api.example.com/api/Documents/Types/Entity/{entityId}
[
  {
    "id": 123,
    "name": "<string>",
    "isClientsEnabled": true,
    "isContactsEnabled": true,
    "isCandidatesEnabled": true,
    "isJobsEnabled": true,
    "isPlacementsEnabled": true,
    "isOpportunitiesEnabled": true,
    "isSitesEnabled": true,
    "defaultDocumentType": true,
    "defaultFormattedCVType": true,
    "defaultSubmittedCVType": true,
    "defaultReferenceCheckType": true
  }
]

Path Parameters

entityId
integer<int32>
required

Entity ID (1=Clients, 2=Contacts, 3=Candidates, 4=Jobs, 5=Placements, 8=Opportunities)

Response

200 - application/json

OK

id
integer<int32>
name
string | null
isClientsEnabled
boolean
isContactsEnabled
boolean
isCandidatesEnabled
boolean
isJobsEnabled
boolean
isPlacementsEnabled
boolean
isOpportunitiesEnabled
boolean
isSitesEnabled
boolean
defaultDocumentType
boolean
defaultFormattedCVType
boolean
defaultSubmittedCVType
boolean
defaultReferenceCheckType
boolean