Navigation

  • index
  • next |
  • previous |
  • interview suite 1.0 documentation »
  • APIv3 »
  • Resources »

Search¶

Note: this feature is experimental and its behaviour may be changed in near future. Contact support if you’d like to use it.

In current implementation searches only candidates by their name and email. Returns only limited amount of fields of the model.

Request¶

/companies/{{companyId}}/search/?q=search_term

Methods¶

  • GET

Response attributes¶

Name Type Description
resource_uri string  
first_name string  
last_name string  
email string  
status string  
photo string  
project.resource_uri string  
project.name string  
project.status string  

Example request¶

curl 'https://staging.interview-suite.com/api/v3/companies/4/search/?q=max%20mustermann' -H 'Authorization: Token <valid_token>'

Example response¶

[
  {
    "email": "max.mustermann+test1@viasto.com",
    "first_name": "Max",
    "last_name": "Mustermann",
    "photo": "https://staging.interview-suite.com/api/v3/companies/4/projects/4220/candidates/40328/photo/",
    "project": {
      "name": "test project #1",
      "resource_uri": "https://staging.interview-suite.com/api/v3/companies/4/projects/4220/",
      "status": "40-running"
    },
    "resource_uri": "https://staging.interview-suite.com/api/v3/companies/4/projects/4220/candidates/40328/",
    "status": "interviewed"
  },
  {
    "email": "max.mustermann+test2@viasto.com",
    "first_name": "Max",
    "last_name": "Mustermann",
    "photo": "",
    "project": {
      "name": "test project #2",
      "resource_uri": "https://staging.interview-suite.com/api/v3/companies/4/projects/4221/",
      "status": "40-running"
    },
    "resource_uri": "https://staging.interview-suite.com/api/v3/companies/4/projects/4221/candidates/40329/",
    "status": "expired"
  }
]

Logo

Navigation

  • Technical Requirements
  • Workflow
  • APIv3
  • Single Sign On (SSO)
  • Webhooks
  • Connector

Table of Contents

  • Search
    • Request
      • Methods
      • Response attributes
      • Example request
      • Example response

Quick search

Navigation

  • index
  • next |
  • previous |
  • interview suite 1.0 documentation »
  • APIv3 »
  • Resources »
© Copyright 2020, viasto GmbH. Created using Sphinx 1.8.5.