Type alias paths

Type declaration

• /v0.1/companies/{companyId}: {
      get: operations["Company"];
  }

  • get: operations["Company"]

    Get company by id

• /v0.1/companies/{companyId}/absence/types: {
      get: operations["AbsenceTypes"];
  }

  • get: operations["AbsenceTypes"]

    Get absence types for company

• /v0.1/companies/{companyId}/addresses/{id}/users: {
      get: operations["CompanyAddressUsers"];
  }

  • get: operations["CompanyAddressUsers"]

    Get company users list for an address

• /v0.1/companies/{companyId}/availability: {
      post: operations["SearchAvailability"];
  }

  • post: operations["SearchAvailability"]

    Get availability for company users. Omitting companyUserId gets availability for all company users in company.

• /v0.1/companies/{companyId}/candidates: {
      get: operations["Candidates"];
      post: operations["AddCompanyCandidate"];
  }

  • get: operations["Candidates"]

    Get Candidates

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • post: operations["AddCompanyCandidate"]

    Create Candidate

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/pipelines: {
      get: operations["CandidatePipelines"];
  }

  • get: operations["CandidatePipelines"]

    Get candidate pipelines

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/recruitment-sources: {
      get: operations["RecruitmentSources"];
  }

  • get: operations["RecruitmentSources"]

    Get recruitment sources

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/search: {
      post: operations["SearchCompanyCandidate"];
  }

  • post: operations["SearchCompanyCandidate"]

    Get company candidates list from search criteria

    Description

    Sample request:

    POST /v0.1/companies/1/candidates/search
    {
        "term": "candidate property value",
        "rating": 3
        "status": 0,
        "sources": [],
        "noRecruiter": false,
        "recruiters": [],
        "states": [0],
        "pipeline": null,
        "pageAndSortBy": {
            "page": 1,
            "itemsPerPage": 15
        },
        "pipelines": []
    }
    Copy

• /v0.1/companies/{companyId}/candidates/{candidateId}/events: {
      get: operations["CompanyCandidateEvents"];
  }

  • get: operations["CompanyCandidateEvents"]

    Get company candidates events list

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{candidateId}/events/meetings: {
      get: operations["CompanyCandidateMeetingEventList"];
      post: operations["NewCompanyCandidateEventMeeting"];
  }

  • get: operations["CompanyCandidateMeetingEventList"]

    Get company candidates events meetings list

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • post: operations["NewCompanyCandidateEventMeeting"]

    Add new meeting event for company candidate

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{candidateId}/events/meetings/{id}: {
      delete: operations["DeleteCompanyCandidateEventMeeting"];
      get: operations["CompanyCandidateEventMeeting"];
      put: operations["UpdateCompanyCandidateEventMeeting"];
  }

  • delete: operations["DeleteCompanyCandidateEventMeeting"]

    Delete company candidate meeting event

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • get: operations["CompanyCandidateEventMeeting"]

    Get company candidates meeting event with specified id

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • put: operations["UpdateCompanyCandidateEventMeeting"]

    Update meeting event for company candidate

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{candidateId}/events/notes: {
      get: operations["CompanyCandidateNoteEventList"];
      post: operations["NewCompanyCandidateEventNote"];
  }

  • get: operations["CompanyCandidateNoteEventList"]

    Get company candidates events notes list

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • post: operations["NewCompanyCandidateEventNote"]

    Add new note event for company candidate

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{candidateId}/events/notes/{id}: {
      delete: operations["DeleteCompanyCandidateEventNote"];
      get: operations["CompanyCandidateEventNote"];
      put: operations["UpdateCompanyCandidateEventNote"];
  }

  • delete: operations["DeleteCompanyCandidateEventNote"]

    Delete company candidate note event

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • get: operations["CompanyCandidateEventNote"]

    Get company candidates note event with specified id

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • put: operations["UpdateCompanyCandidateEventNote"]

    Update note event for company candidate

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{candidateId}/events/tasks: {
      get: operations["CompanyCandidateTaskEventList"];
      post: operations["NewCompanyCandidateEventTask"];
  }

  • get: operations["CompanyCandidateTaskEventList"]

    Get company candidates events tasks list

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • post: operations["NewCompanyCandidateEventTask"]

    Add new task event for company candidate

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{candidateId}/events/tasks/{id}: {
      delete: operations["DeleteCompanyCandidateEventTask"];
      get: operations["CompanyCandidateEventTask"];
      put: operations["UpdateCompanyCandidateEventTask"];
  }

  • delete: operations["DeleteCompanyCandidateEventTask"]

    Delete company candidate task event

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • get: operations["CompanyCandidateEventTask"]

    Get company candidates task event with specified id

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • put: operations["UpdateCompanyCandidateEventTask"]

    Update task event for company candidate

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{candidateId}/events/{id}: {
      get: operations["CompanyCandidateEvent"];
  }

  • get: operations["CompanyCandidateEvent"]

    Get company candidates event by id

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{candidateId}/skills: {
      post: operations["NewCompanyCandidateSkill"];
  }

  • post: operations["NewCompanyCandidateSkill"]

    Add a Skill to company candidate

    Description

    Sample request:

    POST /v0.1/companies/1/candidates/19870/skills
    {
        "name": "SQL",
        "companyCandidateId": 19870,
        "keywordSynonymId": 577,
        "languageId":1
    }
    Copy

• /v0.1/companies/{companyId}/candidates/{candidateId}/skills/{id}: {
      delete: operations["DeleteCompanyCandidateSkill"];
  }

  • delete: operations["DeleteCompanyCandidateSkill"]

    Delete Candidate Skill

    Description

    Sample request:

    DELETE /v0.1/companies/1/candidates/19870/skills/577
    Copy

• /v0.1/companies/{companyId}/candidates/{id}: {
      delete: operations["DeleteCompanyCandidate"];
      get: operations["Candidate"];
      patch: operations["PatchCompanyCandidate"];
  }

  • delete: operations["DeleteCompanyCandidate"]

    Delete candidate from the system This action is irreversible, use with caution

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • get: operations["Candidate"]

    Get Candidate by Id

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • patch: operations["PatchCompanyCandidate"]

    Patch company candidate

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{id}/attachments: {
      post: operations["CandidateAttachment"];
  }

  • post: operations["CandidateAttachment"]

    Upload Candidate File Attachment

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{id}/attachments/{attachmentId}: {
      get: operations["GetCandidateAttachment"];
  }

  • get: operations["GetCandidateAttachment"]

    Get Candidate File Attachment by Id

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{id}/invite: {
      post: operations["InviteCandidate"];
  }

  • post: operations["InviteCandidate"]

    Invite the CompanyCandidate to create their own Cinode account A email is sent with your message and details for how to login

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{id}/uriattachments: {
      post: operations["CandidateUriAttachment"];
  }

  • post: operations["CandidateUriAttachment"]

    Add Candidate Uri (Link)

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/candidates/{id}/uriattachments/{attachmentId}: {
      delete: operations["DeleteCandidateUriAttachment"];
      get: operations["GetCandidateUriAttachment"];
  }

  • delete: operations["DeleteCandidateUriAttachment"]

    Delete Candidate Uri (Link)

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

  • get: operations["GetCandidateUriAttachment"]

    Get Candidate Uri Attachment by Id

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/capabilities: {
      get: operations["CompanyCapabilities"];
  }

  • get: operations["CompanyCapabilities"]

    Get company capabilities

• /v0.1/companies/{companyId}/currencies: {
      get: operations["CompanyCurrencies"];
  }

  • get: operations["CompanyCurrencies"]

    Get company currencies

• /v0.1/companies/{companyId}/customers: {
      get: operations["CompanyCustomers"];
      post: operations["NewCompanyCustomer"];
  }

  • get: operations["CompanyCustomers"]

    Get company customers list

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • post: operations["NewCompanyCustomer"]

    Add company customer

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/contacts/search: {
      post: operations["SearchCompanyCustomerContact"];
  }

  • post: operations["SearchCompanyCustomerContact"]

    Get company customer contacts list from search criteria

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/extended: {
      get: operations["CustomersExtended"];
  }

  • get: operations["CustomersExtended"]

    Get extended company customers list

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/search: {
      post: operations["SearchCompanyCustomer"];
  }

  • post: operations["SearchCompanyCustomer"]

    Get company customers list from search criteria

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/addresses: {
      post: operations["NewCompanyCustomerAddress"];
  }

  • post: operations["NewCompanyCustomerAddress"]

    Add customer address

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/addresses/{id}: {
      delete: operations["DeleteCompanyCustomerAddress"];
      get: operations["CustomerAddress"];
      put: operations["EditCompanyCustomerAddress"];
  }

  • delete: operations["DeleteCompanyCustomerAddress"]

    Delete customer address

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • get: operations["CustomerAddress"]

    Get customer address by id

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • put: operations["EditCompanyCustomerAddress"]

    Update customer address

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/contacts: {
      get: operations["Contacts"];
      post: operations["NewCompanyCustomerContact"];
  }

  • get: operations["Contacts"]

    Get customer contact list

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • post: operations["NewCompanyCustomerContact"]

    Add customer contact

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/contacts/{contactId}/tags: {
      post: operations["EditCustomerContactTags"];
  }

  • post: operations["EditCustomerContactTags"]

    Edit Tags for CustomerContact

    Description

    Note:

    Posted tags will replace any existing tags for the contact.
    A new tag will be created if the Id for a tag is not provided.
    Copy

    Sample request:

    POST /v0.1/companies/1/customers/19870/contacts/5360/tags
    [
        {
            "name": "tag-name",
            "id": 2
        },
        {
            "name": "tag-test",
            "id": 1
        },
    ]
    Copy

• /v0.1/companies/{companyId}/customers/{customerId}/contacts/{id}: {
      delete: operations["DeleteCompanyCustomerContact"];
      get: operations["Contact"];
      put: operations["EditCompanyCustomerContact"];
  }

  • delete: operations["DeleteCompanyCustomerContact"]

    Delete customer contact

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • get: operations["Contact"]

    Get customer contact by id

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • put: operations["EditCompanyCustomerContact"]

    Update customer contact

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/events: {
      get: operations["CompanyCustomerEvents"];
  }

  • get: operations["CompanyCustomerEvents"]

    Get customer events list

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/events/meetings: {
      get: operations["CompanyCustomerEventMeetings"];
      post: operations["NewMeeting"];
  }

  • get: operations["CompanyCustomerEventMeetings"]

    Get customer event meetings list

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • post: operations["NewMeeting"]

    Add customer event meeting

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/events/meetings/{id}: {
      delete: operations["DeleteMeeting"];
      get: operations["CompanyCustomerEventMeeting"];
      put: operations["UpdateMeeting"];
  }

  • delete: operations["DeleteMeeting"]

    Delete customer event meeting

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • get: operations["CompanyCustomerEventMeeting"]

    Get customer event meeting by id

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • put: operations["UpdateMeeting"]

    Update customer event meeting

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/events/notes: {
      get: operations["CompanyCustomerEventNotes"];
      post: operations["NewNote"];
  }

  • get: operations["CompanyCustomerEventNotes"]

    Get customer event notes list

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • post: operations["NewNote"]

    Add customer event note

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/events/notes/{id}: {
      delete: operations["DeleteNote"];
      get: operations["CompanyCustomerEventNote"];
      put: operations["UpdateNote"];
  }

  • delete: operations["DeleteNote"]

    Delete customer event note

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • get: operations["CompanyCustomerEventNote"]

    Get customer event note by id

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • put: operations["UpdateNote"]

    Update customer event note

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/events/tasks: {
      get: operations["CompanyCustomerEventTasks"];
      post: operations["NewTask"];
  }

  • get: operations["CompanyCustomerEventTasks"]

    Get customer event tasks list

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • post: operations["NewTask"]

    Add customer event task

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/events/tasks/{id}: {
      delete: operations["DeleteTask"];
      get: operations["CompanyCustomerEventTask"];
      put: operations["UpdateTask"];
  }

  • delete: operations["DeleteTask"]

    Delete customer event task

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • get: operations["CompanyCustomerEventTask"]

    Get customer event task by id

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • put: operations["UpdateTask"]

    Update customer event task

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/events/{id}: {
      get: operations["CompanyCustomerEvent"];
  }

  • get: operations["CompanyCustomerEvent"]

    Get customer event by id

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{customerId}/managers: {
      get: operations["CompanyCustomerManagers"];
      post: operations["AddCompanyCustomerResponsible"];
  }

  • get: operations["CompanyCustomerManagers"]

    Get customer managers

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • post: operations["AddCompanyCustomerResponsible"]

    Add customer responsible

    Description

    Sample request:

    POST /v0.1/companies/1/customers/22228/managers
    {
        [
           51096
        ]
    }
    Copy

• /v0.1/companies/{companyId}/customers/{customerId}/managers/{id}: {
      delete: operations["RemoveCustomerManager"];
  }

  • delete: operations["RemoveCustomerManager"]

    Remove customer responsible

    Description

    Sample request:

    DELETE /v0.1/companies/1/customers/22228/managers/54632
    Copy

• /v0.1/companies/{companyId}/customers/{customerId}/tags: {
      post: operations["EditCustomerTags"];
  }

  • post: operations["EditCustomerTags"]

    Edit Tags for Customer

    Description

    Note:

    Posted tags will replace any existing tags for the customer.
    A new tag will be created if the Id for a tag is not provided.
    Copy

    Sample request:

    POST /v0.1/companies/1/customers/19870/tags
    [
        {
            "name": "tag-name",
            "id": 2
        },
        {
            "name": "tag-test",
            "id": 1
        },
    ]
    Copy

• /v0.1/companies/{companyId}/customers/{id}: {
      delete: operations["DeleteCompanyCustomer"];
      get: operations["GetCompanyCustomer"];
      patch: operations["PatchCompanyCustomer"];
      put: operations["UpdateCompanyCustomer"];
  }

  • delete: operations["DeleteCompanyCustomer"]

    Delete customer

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • get: operations["GetCompanyCustomer"]

    Get company customer by id

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • patch: operations["PatchCompanyCustomer"]

    Patch company customer

    Description

    Requires access level: CompanyManager. Requires module: Customers.

  • put: operations["UpdateCompanyCustomer"]

    Update company customer

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/customers/{id}/attachments/{attachmentId}: {
      get: operations["GetCustomerAttachment"];
  }

  • get: operations["GetCustomerAttachment"]

    Get customer file attachment by Id

    Description

    Requires access level: CompanyManager. Requires module: Customers.

• /v0.1/companies/{companyId}/employees/{companyUserId}/events: {
      get: operations["CompanyUserEmployeeEvents"];
  }

  • get: operations["CompanyUserEmployeeEvents"]

    Get employee events list

    Description

    Requires access level: CompanyManager.

• /v0.1/companies/{companyId}/employees/{companyUserId}/events/meetings: {
      get: operations["CompanyUserEmployeeEventMeetingList"];
      post: operations["NewCompanyUserEmployeeEventMeeting"];
  }

  • get: operations["CompanyUserEmployeeEventMeetingList"]

    Get employee meetings events list

    Description

    Requires access level: CompanyManager.

  • post: operations["NewCompanyUserEmployeeEventMeeting"]

    Creates new employee meeting event

    Description

    Requires access level: CompanyManager.

• /v0.1/companies/{companyId}/employees/{companyUserId}/events/meetings/{id}: {
      delete: operations["DeleteCompanyUserEmployeeEventMeeting"];
      get: operations["CompanyUserEmployeeEventMeeting"];
      put: operations["UpdateCompanyUserEmployeeEventMeeting"];
  }

  • delete: operations["DeleteCompanyUserEmployeeEventMeeting"]

    Deletes meeting event

    Description

    Requires access level: CompanyManager.

  • get: operations["CompanyUserEmployeeEventMeeting"]

    Get employee meeting event

    Description

    Requires access level: CompanyManager.

  • put: operations["UpdateCompanyUserEmployeeEventMeeting"]

    Updates employee meeting event

    Description

    Requires access level: CompanyManager.

• /v0.1/companies/{companyId}/employees/{companyUserId}/events/notes: {
      get: operations["CompanyUserEmployeeEventNoteList"];
      post: operations["NewCompanyUserEmployeeEventNote"];
  }

  • get: operations["CompanyUserEmployeeEventNoteList"]

    Get employee notes events list

    Description

    Requires access level: CompanyManager.

  • post: operations["NewCompanyUserEmployeeEventNote"]

    Creates new employee note event

    Description

    Requires access level: CompanyManager.

• /v0.1/companies/{companyId}/employees/{companyUserId}/events/notes/{id}: {
      delete: operations["DeleteCompanyUserEmployeeEventNote"];
      get: operations["CompanyUserEmployeeEventNote"];
      put: operations["UpdateCompanyUserEmployeeEventNote"];
  }

  • delete: operations["DeleteCompanyUserEmployeeEventNote"]

    Deletes meeting event

    Description

    Requires access level: CompanyManager.

  • get: operations["CompanyUserEmployeeEventNote"]

    Get employee note event

    Description

    Requires access level: CompanyManager.

  • put: operations["UpdateCompanyUserEmployeeEventNote"]

    Updates employee note event

    Description

    Requires access level: CompanyManager.

• /v0.1/companies/{companyId}/employees/{companyUserId}/events/tasks: {
      get: operations["CompanyUserEmployeeEventTaskList"];
      post: operations["NewCompanyUserEmployeeEventTask"];
  }

  • get: operations["CompanyUserEmployeeEventTaskList"]

    Get employee tasks events list

    Description

    Requires access level: CompanyManager.

  • post: operations["NewCompanyUserEmployeeEventTask"]

    Creates new employee task event

    Description

    Requires access level: CompanyManager.

• /v0.1/companies/{companyId}/employees/{companyUserId}/events/tasks/{id}: {
      delete: operations["DeleteCompanyUserEmployeeEventTask"];
      get: operations["CompanyUserEmployeeEventTask"];
      put: operations["UpdateCompanyUserEmployeeEventTask"];
  }

  • delete: operations["DeleteCompanyUserEmployeeEventTask"]

    Deletes meeting event

    Description

    Requires access level: CompanyManager.

  • get: operations["CompanyUserEmployeeEventTask"]

    Get employee task event

    Description

    Requires access level: CompanyManager.

  • put: operations["UpdateCompanyUserEmployeeEventTask"]

    Updates employee's task event

    Description

    Requires access level: CompanyManager.

• /v0.1/companies/{companyId}/employees/{companyUserId}/events/{id}: {
      get: operations["CompanyUserEmployeeEvent"];
  }

  • get: operations["CompanyUserEmployeeEvent"]

    Get employee event

    Description

    Requires access level: CompanyManager.

• /v0.1/companies/{companyId}/images/{id}: {
      get: operations["CompanyImage"];
  }

  • get: operations["CompanyImage"]

    Get Company Image by Id

• /v0.1/companies/{companyId}/images/{id}/{imageFileName}: {
      get: operations["CompanyImageDownload"];
  }

  • get: operations["CompanyImageDownload"]

    Download Company Image

• /v0.1/companies/{companyId}/keywords/search/{term}: {
      get: operations["SearchKeyword"];
  }

  • get: operations["SearchKeyword"]

    Search keywords by term

• /v0.1/companies/{companyId}/managers: {
      get: operations["CompanyManagers"];
  }

  • get: operations["CompanyManagers"]

    Get company managers

    Description

    Sample request:

    GET /v0.1/companies/1/managers
    Copy

• /v0.1/companies/{companyId}/mentions/to-natural-text: {
      post: operations["TranslateMentions"];
  }

  • post: operations["TranslateMentions"]

    Translates any mention-ids in a text to their human readable form. Translations are access restricted, if you don't have enough access to get the name of an id, it won't be translated.

• /v0.1/companies/{companyId}/partners: {
      post: operations["SearchPartners"];
  }

  • post: operations["SearchPartners"]

    Get Partners by filter

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/profiles: {
      post: operations["CompanyProfiles"];
  }

  • post: operations["CompanyProfiles"]

    Get profiles list

    Description

    Sample request:

    POST /v0.1/companies/1/profiles
    {
        "createdOffsetDays": 90,
        "updatedOffsetDays": 30,
        "pageAndSortBy": {
            "page": 1,
            "itemsPerPage": 15,
            "order": 0,
            "sortBy": 1
        }
    }
    Copy

• /v0.1/companies/{companyId}/projects: {
      get: operations["Projects"];
      post: operations["NewCompanyProject"];
  }

  • get: operations["Projects"]

    Get projects list - please note this endpoint currently only returns projects with the status WON. Please use the SearchProjects endpoint for more options of filtering desired Projects

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • post: operations["NewCompanyProject"]

    Add project

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/pipelines: {
      get: operations["ProjectPipelines"];
  }

  • get: operations["ProjectPipelines"]

    Get project pipelines

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/search: {
      post: operations["SearchProject"];
  }

  • post: operations["SearchProject"]

    Get projects list from search criteria

    Description

    Sample request { "pipelines": [4], "projectStates": [0], "PageAndSortBy": { "SortBy": "0", "SortOrder": "1", "Page": "1", "ItemsPerPage": "15", } } SortBy Parameter can be: CreatedDateTime=0 // Default Title=1 Identifier=2 CustomerIdentifier=3 SeoId=4 UpdatedDateTime=6 LastTouchDateTime=7

• /v0.1/companies/{companyId}/projects/{id}: {
      delete: operations["DeleteCompanyProject"];
      get: operations["Project"];
      put: operations["UpdateCompanyProject"];
  }

  • delete: operations["DeleteCompanyProject"]

    Delete project

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • get: operations["Project"]

    Get project by id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • put: operations["UpdateCompanyProject"]

    Update project

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{id}/attachments/{attachmentId}: {
      get: operations["GetProjectAttachment"];
  }

  • get: operations["GetProjectAttachment"]

    Get Project file attachment by Id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/events: {
      get: operations["ProjectEvents"];
  }

  • get: operations["ProjectEvents"]

    Get project events list

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/events/meetings: {
      get: operations["ProjectEventMeetings"];
      post: operations["NewProjectMeeting"];
  }

  • get: operations["ProjectEventMeetings"]

    Get project events meetings list

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • post: operations["NewProjectMeeting"]

    Add project event meeting

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/events/meetings/{id}: {
      delete: operations["DeleteProjectMeeting"];
      get: operations["ProjectEventMeeting"];
      put: operations["UpdateProjectMeeting"];
  }

  • delete: operations["DeleteProjectMeeting"]

    Delete project event meeting

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • get: operations["ProjectEventMeeting"]

    Get project event meeting by id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • put: operations["UpdateProjectMeeting"]

    Update project event meeting

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/events/notes: {
      get: operations["ProjectEventNotes"];
      post: operations["NewProjectNote"];
  }

  • get: operations["ProjectEventNotes"]

    Get project event notes list

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • post: operations["NewProjectNote"]

    Add project event note

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/events/notes/{id}: {
      delete: operations["DeleteProjectNote"];
      get: operations["ProjectEventNote"];
      put: operations["UpdateProjectNote"];
  }

  • delete: operations["DeleteProjectNote"]

    Delete project event note

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • get: operations["ProjectEventNote"]

    Get project event note by id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • put: operations["UpdateProjectNote"]

    Update project event note

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/events/tasks: {
      get: operations["ProjectEventTasks"];
      post: operations["NewProjectTask"];
  }

  • get: operations["ProjectEventTasks"]

    Get project event tasks list

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • post: operations["NewProjectTask"]

    Add project event task

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/events/tasks/{id}: {
      delete: operations["DeleteProjectTask"];
      get: operations["ProjectEventTask"];
      put: operations["UpdateProjectTask"];
  }

  • delete: operations["DeleteProjectTask"]

    Delete project event task

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • get: operations["ProjectEventTask"]

    Get project event task by id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • put: operations["UpdateProjectTask"]

    Update project event task

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/events/{id}: {
      get: operations["ProjectEvent"];
  }

  • get: operations["ProjectEvent"]

    Get project event by id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/projectassignments/{id}: {
      get: operations["OldProjectAssignment"];
  }

  • get: operations["OldProjectAssignment"]

    Get projectassignment by id (Obsolete)

    Deprecated

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/references: {
      get: operations["ProjectReferences"];
  }

  • get: operations["ProjectReferences"]

    Get project reference by id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/references/{id}: {
      get: operations["ProjectReference"];
  }

  • get: operations["ProjectReference"]

    Get project reference by id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles: {
      post: operations["NewProjectAssignment"];
  }

  • post: operations["NewProjectAssignment"]

    Add Role

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles/{id}: {
      delete: operations["DeleteProjectAssignment"];
      get: operations["ProjectAssignment"];
      put: operations["UpdateProjectAssignment"];
  }

  • delete: operations["DeleteProjectAssignment"]

    Delete Role

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • get: operations["ProjectAssignment"]

    Get Role by id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • put: operations["UpdateProjectAssignment"]

    Edit Role

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles/{projectAssignmentId}/announce: {
      post: operations["AnnounceProjectAssignment"];
  }

  • post: operations["AnnounceProjectAssignment"]

    Announce a role (ProjectAssignment) to the Partner Network and optionally also to Cinode Market(https://cinode.market/requests). If you are testing, set the "PublishForReal" to "false", otherwise you will publish this announcement for real. When you're testing ("PublishForReal = false) RequestId will be 0 in the response.

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles/{roleId}/members/employee: {
      post: operations["AddProjectAssignmentMemberEmployee"];
  }

  • post: operations["AddProjectAssignmentMemberEmployee"]

    Add Role Member Employee

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles/{roleId}/members/employee/{id}: {
      put: operations["UpdateProjectAssignmentMemberEmployee"];
  }

  • put: operations["UpdateProjectAssignmentMemberEmployee"]

    Edit Role Member Employee

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles/{roleId}/members/subcontractor: {
      post: operations["AddProjectAssignmentMemberSubcontractor"];
  }

  • post: operations["AddProjectAssignmentMemberSubcontractor"]

    Add Role Member Subcontractor

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles/{roleId}/members/subcontractor/{id}: {
      put: operations["UpdateProjectAssignmentMemberSubcontractor"];
  }

  • put: operations["UpdateProjectAssignmentMemberSubcontractor"]

    Edit Role Member Subcontractor

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles/{roleId}/members/{id}: {
      delete: operations["DeleteProjectAssignmentMemberEmployee"];
  }

  • delete: operations["DeleteProjectAssignmentMemberEmployee"]

    Delete Role Member

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles/{roleId}/skills: {
      post: operations["AddProjectAssignmentSkill"];
  }

  • post: operations["AddProjectAssignmentSkill"]

    Add Role Skill

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/roles/{roleId}/skills/{id}: {
      delete: operations["DeleteProjectAssignmentSkill"];
      put: operations["UpdateProjectAssignmentSkill"];
  }

  • delete: operations["DeleteProjectAssignmentSkill"]

    Delete Role Skill

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

  • put: operations["UpdateProjectAssignmentSkill"]

    Update Role Skill

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/projects/{projectId}/tags: {
      post: operations["EditProjectTags"];
  }

  • post: operations["EditProjectTags"]

    Edit Tags for Project

    Description

    Note:

    Posted tags will replace any existing tags for the project.
    A new tag will be created, if the id for a tag not provided.
    Copy

    Sample request:

    POST /v0.1/companies/1/projects/19870/tags
    [
        {
            "name": "tag-name",
            "id": 2
        },
        {
            "name": "tag-test",
            "id": 1
        },
    ]
    Copy

• /v0.1/companies/{companyId}/recruitment/managers: {
      get: operations["RecruitmentManagers"];
  }

  • get: operations["RecruitmentManagers"]

    Get recruitment managers

    Description

    Requires access level: CompanyRecruiter. Requires module: Recruitment.

• /v0.1/companies/{companyId}/resumes: {
      get: operations["CompanyResumes"];
  }

  • get: operations["CompanyResumes"]

    Get resumes list

    Description

    Requires module: CompanyUserResume.

• /v0.1/companies/{companyId}/roles: {
      post: operations["SearchRoles"];
  }

  • post: operations["SearchRoles"]

    Get Roles by Filter Rate limited, restricted to once per minute, max 1000 requests per day

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/skills/search: {
      post: operations["SearchSkill"];
  }

  • post: operations["SearchSkill"]

    Search users by skill keyword id

• /v0.1/companies/{companyId}/skills/search/term: {
      post: operations["SearchSkillTerm"];
  }

  • post: operations["SearchSkillTerm"]

    Search users with skills by term (string value)

• /v0.1/companies/{companyId}/subcontractors: {
      get: operations["CompanyUserSubcontractors"];
      post: operations["AddCompanyUserSubcontractor"];
  }

  • get: operations["CompanyUserSubcontractors"]

    Get subcontractors list

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • post: operations["AddCompanyUserSubcontractor"]

    Add subcontractor

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/groups: {
      get: operations["GetCompanySubcontractorGroups"];
  }

  • get: operations["GetCompanySubcontractorGroups"]

    Get Subcontractor Groups by Company Id

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/groups/{subcontractorGroupId}: {
      get: operations["GetCompanySubcontractorGroup"];
  }

  • get: operations["GetCompanySubcontractorGroup"]

    Get Subcontractor Group by Id

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/groups/{subcontractorGroupId}/members: {
      post: operations["AddCompanySubcontractorGroupMember"];
  }

  • post: operations["AddCompanySubcontractorGroupMember"]

    Add subcontractor group member

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/groups/{subcontractorGroupId}/members/{id}: {
      delete: operations["DeleteCompanySubcontractorGroupMember"];
  }

  • delete: operations["DeleteCompanySubcontractorGroupMember"]

    Delete subcontractor group member

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{companyUserId}/events/meetings: {
      get: operations["CompanyUserSubcontractorEventMeetingList"];
      post: operations["NewCompanyUserSubcontractorEventMeeting"];
  }

  • get: operations["CompanyUserSubcontractorEventMeetingList"]

    Get subcontractors meetings events list

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • post: operations["NewCompanyUserSubcontractorEventMeeting"]

    Creates new subcontractor meeting event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{companyUserId}/events/meetings/{id}: {
      delete: operations["DeleteCompanyUserSubcontractorEventMeeting"];
      get: operations["CompanyUserSubcontractorEventMeeting"];
      put: operations["UpdateCompanyUserSubcontractorEventMeeting"];
  }

  • delete: operations["DeleteCompanyUserSubcontractorEventMeeting"]

    Deletes meeting event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • get: operations["CompanyUserSubcontractorEventMeeting"]

    Get subcontractor meeting event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • put: operations["UpdateCompanyUserSubcontractorEventMeeting"]

    Updates subcontractor meeting event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{companyUserId}/events/notes: {
      get: operations["CompanyUserSubcontractorEventsNotes"];
      post: operations["NewCompanyUserSubcontractorEventNote"];
  }

  • get: operations["CompanyUserSubcontractorEventsNotes"]

    Get subcontractors notes events list

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • post: operations["NewCompanyUserSubcontractorEventNote"]

    Creates new subcontractors note event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{companyUserId}/events/notes/{id}: {
      delete: operations["DeleteCompanyUserSubcontractorEventNote"];
      get: operations["CompanyUserSubcontractorEventNote"];
      put: operations["UpdateCompanyUserSubcontractorEventNote"];
  }

  • delete: operations["DeleteCompanyUserSubcontractorEventNote"]

    Deletes meeting event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • get: operations["CompanyUserSubcontractorEventNote"]

    Get subcontractors notes events list

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • put: operations["UpdateCompanyUserSubcontractorEventNote"]

    Updates subcontractor note event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{companyUserId}/events/tasks: {
      get: operations["CompanyUserSubcontractorEventsTasks"];
      post: operations["NewCompanyUserSubcontractorEventTask"];
  }

  • get: operations["CompanyUserSubcontractorEventsTasks"]

    Get subcontractors tasks events list

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • post: operations["NewCompanyUserSubcontractorEventTask"]

    Creates new subcontractor task event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{companyUserId}/events/tasks/{id}: {
      delete: operations["DeleteCompanyUserSubcontractorEventTask"];
      get: operations["CompanyUserSubcontractorEventTask"];
      put: operations["UpdateCompanyUserSubcontractorEventTask"];
  }

  • delete: operations["DeleteCompanyUserSubcontractorEventTask"]

    Deletes meeting event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • get: operations["CompanyUserSubcontractorEventTask"]

    Get subcontractors tasks events list

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • put: operations["UpdateCompanyUserSubcontractorEventTask"]

    Updates subcontractor task event

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{companyUserId}/events/{id}: {
      get: operations["CompanyUserSubcontractorEvent"];
  }

  • get: operations["CompanyUserSubcontractorEvent"]

    Get subcontractors events list

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{id}: {
      delete: operations["DeleteCompanySubcontractor"];
      get: operations["CompanySubcontractor"];
  }

  • delete: operations["DeleteCompanySubcontractor"]

    Delete subcontractor from the system This action is irreversible, use with caution

    Description

    Requires access level: PartnerManager. Requires module: Partners.

  • get: operations["CompanySubcontractor"]

    Get company user by id

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{id}/attachments: {
      post: operations["SubcontractorAttachment"];
  }

  • post: operations["SubcontractorAttachment"]

    Upload subcontractor file attachment

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{id}/attachments/{attachmentId}: {
      get: operations["GetSubcontractorAttachment"];
  }

  • get: operations["GetSubcontractorAttachment"]

    Get subcontractor File Attachment by Id

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/subcontractors/{subcontractorId}/events: {
      get: operations["CompanyUserSubcontractorEvents"];
  }

  • get: operations["CompanyUserSubcontractorEvents"]

    Get subcontractors events list

    Description

    Requires access level: PartnerManager. Requires module: Partners.

• /v0.1/companies/{companyId}/tags: {
      get: operations["CompanyTags"];
  }

  • get: operations["CompanyTags"]

    Get company tags

    Description

    Sample request:

    GET /v0.1/companies/1/tags
    Copy

• /v0.1/companies/{companyId}/tags/{id}: {
      get: operations["CompanyTag"];
  }

  • get: operations["CompanyTag"]

    Get company tag by Id

    Description

    Sample request:

    GET /v0.1/companies/1/tags/1
    Copy

• /v0.1/companies/{companyId}/teams: {
      get: operations["CompanyTeams"];
      post: operations["NewTeam"];
  }

  • get: operations["CompanyTeams"]

    Get teams list

  • post: operations["NewTeam"]

    Add team

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/teams/{id}: {
      get: operations["Team"];
      put: operations["UpdateTeam"];
  }

  • get: operations["Team"]

    Get team by id

  • put: operations["UpdateTeam"]

    Update team

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/teams/{teamId}/managers: {
      get: operations["TeamManagers"];
      post: operations["AddTeamManager"];
  }

  • get: operations["TeamManagers"]

    Get team managers

  • post: operations["AddTeamManager"]

    Add team manager

    Description

    Sample request:

    POST /v0.1/companies/1/teams/1234/managers
    {
        "teamId" : 1234,
        "companyUserId" : 54632
    }
    Copy

• /v0.1/companies/{companyId}/teams/{teamId}/managers/{id}: {
      delete: operations["RemoveTeamManager"];
  }

  • delete: operations["RemoveTeamManager"]

    Remove team manager

    Description

    Sample request:

    DELETE /v0.1/companies/1/teams/1234/managers/54632
    Copy

• /v0.1/companies/{companyId}/teams/{teamId}/members: {
      get: operations["GetTeamMembers"];
      post: operations["AddTeamMember"];
  }

  • get: operations["GetTeamMembers"]

    Get team members

  • post: operations["AddTeamMember"]

    Add team member

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/teams/{teamId}/members/{id}: {
      delete: operations["RemoveTeamMember"];
      get: operations["GetTeamMember"];
      put: operations["UpdateTeamMember"];
  }

  • delete: operations["RemoveTeamMember"]

    Remove team member

    Description

    Requires access level: CompanyAdmin.

  • get: operations["GetTeamMember"]

    Get team member

  • put: operations["UpdateTeamMember"]

    Update team member

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/teams/{teamId}/members/{id}/move: {
      post: operations["MoveTeamMember"];
  }

  • post: operations["MoveTeamMember"]

    Move team member and associated bookings to another team

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/teams/{teamId}/users: {
      get: operations["GetTeamUsers"];
      post: operations["AddTeamUser"];
  }

  • get: operations["GetTeamUsers"]

    Get team members

    Deprecated

  • post: operations["AddTeamUser"]

    Add team member

    Deprecated

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/teams/{teamId}/users/{id}: {
      delete: operations["RemoveTeamUser"];
  }

  • delete: operations["RemoveTeamUser"]

    Remove team member

    Deprecated

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/users: {
      get: operations["CompanyUsers"];
      post: operations["AddCompanyUser"];
  }

  • get: operations["CompanyUsers"]

    Get company users list

  • post: operations["AddCompanyUser"]

    Add company user employee

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/users-full/{id}: {
      get: operations["UserFull"];
  }

  • get: operations["UserFull"]

    Get company user, including financial fields, by id

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/users/extended: {
      get: operations["CompanyUsersExtended"];
  }

  • get: operations["CompanyUsersExtended"]

    Get extended company users list

• /v0.1/companies/{companyId}/users/search: {
      post: operations["SearchCompanyUser"];
  }

  • post: operations["SearchCompanyUser"]

    Get company users list from search criteria

• /v0.1/companies/{companyId}/users/{companyUserId}/absences: {
      get: operations["Absences"];
      post: operations["NewAbsence"];
  }

  • get: operations["Absences"]

    Get absence period by company user id

  • post: operations["NewAbsence"]

    Create Absence Item for User

• /v0.1/companies/{companyId}/users/{companyUserId}/absences/{id}: {
      delete: operations["DeleteAbsence"];
      get: operations["Absence"];
      put: operations["UpdateAbsence"];
  }

  • delete: operations["DeleteAbsence"]

    Delete absence

  • get: operations["Absence"]

    Get absence period by id

  • put: operations["UpdateAbsence"]

    Update Absence Item for User

• /v0.1/companies/{companyId}/users/{companyUserId}/convert-aad: {
      post: operations["ConvertUserToAadAccount"];
  }

  • post: operations["ConvertUserToAadAccount"]

    Convert company user employee to an AAD account

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/users/{companyUserId}/permissions: {
      put: operations["UpdatePermissions"];
  }

  • put: operations["UpdatePermissions"]

    Update Permissions for Company User

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/users/{companyUserId}/profile: {
      get: operations["CompanyUserProfile"];
      post: operations["NewCompanyUserProfile"];
  }

  • get: operations["CompanyUserProfile"]

    Get profile by company user id

  • post: operations["NewCompanyUserProfile"]

    Create Profile for user

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/commitments: {
      post: operations["NewCompanyUserProfileCommitment"];
  }

  • post: operations["NewCompanyUserProfileCommitment"]

    Create Profile Commitment

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/commitments/{id}: {
      delete: operations["DeleteCompanyUserProfileCommitment"];
      get: operations["CompanyUserProfileCommitment"];
      put: operations["UpdateCompanyUserProfileCommitment"];
  }

  • delete: operations["DeleteCompanyUserProfileCommitment"]

    Delete Commitment

  • get: operations["CompanyUserProfileCommitment"]

    Get profile commitment by id

  • put: operations["UpdateCompanyUserProfileCommitment"]

    Update Profile Commitment

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/educations: {
      post: operations["NewCompanyUserProfileEducation"];
  }

  • post: operations["NewCompanyUserProfileEducation"]

    Create Profile Education

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/educations/{id}: {
      delete: operations["DeleteCompanyUserProfileEducation"];
      get: operations["CompanyUserProfileEducation"];
      put: operations["UpdateCompanyUserProfileEducation"];
  }

  • delete: operations["DeleteCompanyUserProfileEducation"]

    Delete Profile Education

  • get: operations["CompanyUserProfileEducation"]

    Get profile education by id

  • put: operations["UpdateCompanyUserProfileEducation"]

    Update Profile Education

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/employers: {
      post: operations["NewCompanyUserProfileEmployer"];
  }

  • post: operations["NewCompanyUserProfileEmployer"]

    Create Employer profile item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/employers/{id}: {
      delete: operations["DeleteCompanyUserProfileEmployer"];
      get: operations["CompanyUserProfileEmployer"];
      put: operations["UpdateCompanyUserProfileEmployer"];
  }

  • delete: operations["DeleteCompanyUserProfileEmployer"]

    Delete Profile Employer

  • get: operations["CompanyUserProfileEmployer"]

    Get profile employer by id

  • put: operations["UpdateCompanyUserProfileEmployer"]

    Update Profile Employer

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/extskills: {
      post: operations["NewCompanyUserProfileExtSkill"];
  }

  • post: operations["NewCompanyUserProfileExtSkill"]

    Create Extra Skill Profile Item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/extskills/{id}: {
      delete: operations["DeleteCompanyUserProfileExtSkill"];
      get: operations["CompanyUserProfileExtSkill"];
      put: operations["UpdateCompanyUserProfileExtSkill"];
  }

  • delete: operations["DeleteCompanyUserProfileExtSkill"]

    Delete Extra Skill Profile Item

  • get: operations["CompanyUserProfileExtSkill"]

    Get profile external skill by id

  • put: operations["UpdateCompanyUserProfileExtSkill"]

    Update Extra Skill Profile Item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/import: {
      post: operations["CreateCompanyUserProfileImport"];
  }

  • post: operations["CreateCompanyUserProfileImport"]

    Create new profile import for a user.

    Description

    This will start an async operation.

    • If the operation is started successfully, the response will be 202 Accepted and the Location header will contain the URL to get the status of the operation.
    • If the operation is not started successfully, the response will be 400 Bad Request

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/import/{operationId}: {
      get: operations["GetCompanyUserProfileImport"];
  }

  • get: operations["GetCompanyUserProfileImport"]

    Get current status of the async profile import operation.

    Description

    This will return the status of an async operation.

    • If the operation is still in progress, the response will be 202 Accepted
    • If the operation is completed successfully, the response will be 200 OK and the status property will be Completed
    • If the operation is completed with errors, the response will be 200 OK and the status property will be Failed

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/languages: {
      post: operations["NewCompanyUserProfileLanguage"];
  }

  • post: operations["NewCompanyUserProfileLanguage"]

    Create Language Profile Item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/languages/{id}: {
      delete: operations["DeleteCompanyUserProfileLanguage"];
      get: operations["CompanyUserProfileLanguage"];
      put: operations["UpdateCompanyUserProfileLanguage"];
  }

  • delete: operations["DeleteCompanyUserProfileLanguage"]

    Delete Language Profile Item

  • get: operations["CompanyUserProfileLanguage"]

    Get profile language by id

  • put: operations["UpdateCompanyUserProfileLanguage"]

    Update Language Profile Item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/presentation: {
      get: operations["CompanyUserProfilePresentation"];
      put: operations["UpdateCompanyUserProfilePresentation"];
  }

  • get: operations["CompanyUserProfilePresentation"]

    Get profile presentation

  • put: operations["UpdateCompanyUserProfilePresentation"]

    Edit Profile Presentation

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/references: {
      post: operations["NewCompanyUserProfileReference"];
  }

  • post: operations["NewCompanyUserProfileReference"]

    Create Profile Reference Item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/references/{id}: {
      delete: operations["DeleteCompanyUserProfileReference"];
      get: operations["CompanyUserProfileReference"];
      put: operations["UpdateCompanyUserProfileReference"];
  }

  • delete: operations["DeleteCompanyUserProfileReference"]

    Delete Profile Reference Item

  • get: operations["CompanyUserProfileReference"]

    Get profile reference by id

  • put: operations["UpdateCompanyUserProfileReference"]

    Update Profile Reference Item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/skills: {
      post: operations["NewCompanyUserProfileSkill"];
  }

  • post: operations["NewCompanyUserProfileSkill"]

    Add Skill to profile

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/skills/{id}: {
      delete: operations["DeleteCompanyUserProfileSkill"];
      get: operations["CompanyUserProfileSkill"];
      put: operations["UpdateCompanyUserProfileSkill"];
  }

  • delete: operations["DeleteCompanyUserProfileSkill"]

    Delete Profile Skill

  • get: operations["CompanyUserProfileSkill"]

    Get profile skill by id

  • put: operations["UpdateCompanyUserProfileSkill"]

    Update Profile Skill

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/trainings: {
      post: operations["NewCompanyUserProfileTraining"];
  }

  • post: operations["NewCompanyUserProfileTraining"]

    Create Profile Training Item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/trainings/{id}: {
      delete: operations["DeleteCompanyUserProfileTraining"];
      get: operations["CompanyUserProfileTraining"];
      put: operations["UpdateCompanyUserProfileTraining"];
  }

  • delete: operations["DeleteCompanyUserProfileTraining"]

    Delete Profile Training Item

  • get: operations["CompanyUserProfileTraining"]

    Get profile training by id

  • put: operations["UpdateCompanyUserProfileTraining"]

    Update Profile Training Item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/workexperiences: {
      post: operations["NewCompanyUserProfileWorkExperience"];
  }

  • post: operations["NewCompanyUserProfileWorkExperience"]

    Create WorkExperience Profile Item

• /v0.1/companies/{companyId}/users/{companyUserId}/profile/workexperiences/{id}: {
      delete: operations["DeleteCompanyUserProfileWorkExperience"];
      get: operations["CompanyUserProfileWorkExperience"];
      put: operations["UpdateCompanyUserProfileWorkExperience"];
  }

  • delete: operations["DeleteCompanyUserProfileWorkExperience"]

    Delete Profile Work Experience Item

  • get: operations["CompanyUserProfileWorkExperience"]

    Get profile work experience by id

  • put: operations["UpdateCompanyUserProfileWorkExperience"]

    Update Profile Work Experience

• /v0.1/companies/{companyId}/users/{companyUserId}/profiles: {
      get: operations["CompanyUserProfiles"];
  }

  • get: operations["CompanyUserProfiles"]

    Get profiles list

• /v0.1/companies/{companyId}/users/{companyUserId}/resumes: {
      get: operations["CompanyUserResumes"];
  }

  • get: operations["CompanyUserResumes"]

    Get company user resumes list

    Description

    Requires module: CompanyUserResume.

• /v0.1/companies/{companyId}/users/{companyUserId}/resumes/{id}: {
      get: operations["GetResume"];
  }

  • get: operations["GetResume"]

    Get resume by id

    Description

    Requires module: CompanyUserResume.

• /v0.1/companies/{companyId}/users/{companyUserId}/resumes/{id}/dynamic: {
      get: operations["DynamicResume"];
  }

  • get: operations["DynamicResume"]

    Get resume by id

    Description

    Requires module: CompanyUserResume.

• /v0.1/companies/{companyId}/users/{companyUserId}/skills: {
      get: operations["Skills"];
  }

  • get: operations["Skills"]

    Get skills list

• /v0.1/companies/{companyId}/users/{companyUserId}/skills/{id}: {
      get: operations["Skill"];
  }

  • get: operations["Skill"]

    Get skill by id

• /v0.1/companies/{companyId}/users/{companyUserId}/tags: {
      post: operations["EditCompanyUserTags"];
  }

  • post: operations["EditCompanyUserTags"]

    Edit Tags for User

    Description

    Note:

    Posted tags will replace any existing tags for the user.
    A new tag will be created if the id for a tag is not provided.
    Copy

    Sample request:

    POST /v0.1/companies/1/users/19870/tags
    [
        {
            "name": "tag-name",
            "id": 2
        },
        {
            "name": "tag-new",
        },
    ]
    Copy

• /v0.1/companies/{companyId}/users/{companyUserId}/teams: {
      get: operations["UserTeams"];
  }

  • get: operations["UserTeams"]

    Get teams for team member

• /v0.1/companies/{companyId}/users/{id}: {
      delete: operations["DeleteCompanyUser"];
      get: operations["User"];
      patch: operations["PatchCompanyUser"];
      put: operations["UpdateCompanyUser"];
  }

  • delete: operations["DeleteCompanyUser"]

    Delete user from the system Firstly, the user has to be disconnected, which can be done through a PATCH or PUT This action is irreversible, use with caution

    Description

    Requires access level: CompanyAdmin.

  • get: operations["User"]

    Get company user by id

  • patch: operations["PatchCompanyUser"]

    Patch company user

    Description

    Requires access level: CompanyAdmin.

  • put: operations["UpdateCompanyUser"]

    Update company user

    Description

    Requires access level: CompanyAdmin.

• /v0.1/companies/{companyId}/users/{id}/images: {
      get: operations["CompanyImages"];
      post: operations["AddCompanyImage"];
  }

  • get: operations["CompanyImages"]

    Get Company Images Assigned to User

  • post: operations["AddCompanyImage"]

    Add Image to User

• /v0.1/companies/{companyId}/users/{id}/roles: {
      get: operations["CompanyUserRoles"];
  }

  • get: operations["CompanyUserRoles"]

    Get Roles for CompanyUser by id

    Description

    Requires access level: CompanyManager. Requires module: Assignments.

• /v0.1/companies/{companyId}/webhooks: {
      get: operations["CompanyWebhooks"];
      post: operations["NewWebhook"];
  }

  • get: operations["CompanyWebhooks"]

    Get company webhooks

    Description

    Sample request:

    GET /v0.1/companies/1/webhooks
    Copy

  • post: operations["NewWebhook"]

    Add Webhook

    Description

    Sample request:

    POST /v0.1/companies/1/webhooks
    {
        "isActive": false,
        "endpointUrl": "https://webhook.site/7a619ffb-e67c-41fc-8113-083d6013f76c",
        "configurations": [
            {
                "entityType": 1,
                "actionType": 1
            }
        ],
        "credentials": [
            {
                "isBasicAuthentication": true,
                "headerName": "user",
                "headerValue": "somevalue"
            }
        ]
    }
    Copy

• /v0.1/companies/{companyId}/webhooks/manifest: {
      post: operations["InstallWebhookManifest"];
  }

  • post: operations["InstallWebhookManifest"]

    Description

    Requires access level: CompanyAdmin. Requires module: Webhooks.

• /v0.1/companies/{companyId}/webhooks/{id}: {
      delete: operations["RemoveWebhook"];
  }

  • delete: operations["RemoveWebhook"]

    Remove webhook

    Description

    Sample request:

    DELETE /v0.1/companies/1/webhooks/42a3a220-766c-eb11-8e13-000c29b4e92f
    Copy

• /v0.1/languages: {
      get: operations["ProfileLanguages"];
  }

  • get: operations["ProfileLanguages"]

    Get Available Profile Languages