> For the complete documentation index, see [llms.txt](https://cruit-docs.zisoo.nl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cruit-docs.zisoo.nl/portal-endpoints/vacancy.md).

# Vacancy

## Get all vacancies

<mark style="color:blue;">`GET`</mark> `https://cruit-api.zisoo.nl/api/v1/portal/vacancy`

Get a list of all your vacancies

#### Headers

| Name          | Type   | Description                |
| ------------- | ------ | -------------------------- |
| Authorization | string | JWT token in Bearer format |

{% tabs %}
{% tab title="200 " %}

```
{
  "vacancies": [
    {
      "id": 1,
      "name": "Werkstudent Business Development, Marketing & Communicatie",
      "recruiting_project_id": 12345678,
      "department_id": 12345678,
      "personal_info": [
        {
          "label": "title",
          "name": "Titel",
          "enabled": false,
          "required": false
        },
        {
          "label": "firstname",
          "name": "Voornaam",
          "enabled": true,
          "required": true
        },
        {
          "label": "middle_name",
          "name": "Tweede naam",
          "enabled": false,
          "required": false
        },
        {
          "label": "lastname",
          "name": "Achternaam",
          "enabled": true,
          "required": true
        },
        {
          "label": "email",
          "name": "Email",
          "enabled": true,
          "required": true
        },
        {
          "label": "gender",
          "name": "Aanhef",
          "enabled": true,
          "required": false
        },
        {
          "label": "phone",
          "name": "Telefoonnummer",
          "enabled": true,
          "required": false
        },
        {
          "label": "date_of_birth",
          "name": "Geboortedatum",
          "enabled": false,
          "required": false
        }
      ]
    }
  ]
}
```

{% endtab %}
{% endtabs %}

## Show vacancy

<mark style="color:blue;">`GET`</mark> `https://cruit-api.zisoo.nl/api/v1/portal/vacancy/:vacancyId`

Get details of vacancy

#### Headers

| Name          | Type   | Description                |
| ------------- | ------ | -------------------------- |
| Authorization | string | JWT token in Bearer format |

{% tabs %}
{% tab title="200 " %}

```
{
  "vacancy": {
    "id": 1,
    "name": "Werkstudent Business Development, Marketing & Communicatie",
    "recruiting_project_id": 12345678,
    "department_id": 12345678,
    "personal_info": [
      {
        "label": "title",
        "name": "Titel",
        "enabled": false,
        "required": false
      },
      {
        "label": "firstname",
        "name": "Voornaam",
        "enabled": true,
        "required": true
      },
      {
        "label": "middle_name",
        "name": "Tweede naam",
        "enabled": false,
        "required": false
      },
      {
        "label": "lastname",
        "name": "Achternaam",
        "enabled": true,
        "required": true
      },
      {
        "label": "email",
        "name": "Email",
        "enabled": true,
        "required": true
      },
      {
        "label": "gender",
        "name": "Aanhef",
        "enabled": true,
        "required": false
      },
      {
        "label": "phone",
        "name": "Telefoonnummer",
        "enabled": true,
        "required": false
      },
      {
        "label": "date_of_birth",
        "name": "Geboortedatum",
        "enabled": false,
        "required": false
      }
    ],
    "logs": [
      {
        "action": "application",
        "message": "Application invalid",
        "status": "failed",
        "test_request": true,
        "created_at": "Fri 11:11"
      },
      {
        "action": "application",
        "message": "Application invalid",
        "status": "failed",
        "test_request": true,
        "created_at": "Fri 12:53"
      },
      {
        "action": "application",
        "message": "Application is created",
        "status": "success",
        "test_request": true,
        "created_at": "Fri 12:53"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## Download vacancy form template

<mark style="color:blue;">`GET`</mark> `https://cruit-api.zisoo.nl/api/v1/portal/vacancy/:vacancyId/download`

Get generated vacancy form template

#### Headers

| Name          | Type   | Description                |
| ------------- | ------ | -------------------------- |
| Authorization | string | JWT token in Bearer format |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Create vacancy

<mark style="color:green;">`POST`</mark> `https://cruit-api.zisoo.nl/api/v1/portal/vacancy`

Create new vacancy

#### Headers

| Name          | Type   | Description                |
| ------------- | ------ | -------------------------- |
| Authorization | string | JWT token in Bearer format |

#### Request Body

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| general | object |             |

{% tabs %}
{% tab title="201 " %}

```
{
  "vacancy": {
    "id": 1,
    "user_id": 1,
    "name": "Nieuwe vacature",
    "created_at": "2020-08-20T11:06:15.628Z",
    "updated_at": "2020-08-20T11:06:15.628Z",
    "recruiting_project_id": 12345678,
    "department_id": 12345678
  }
}
```

{% endtab %}
{% endtabs %}

JSON body example:

```
{
  "general": {
    "name": "Example vacancy",
    "department_id": 12345,
    "recruiting_project_id": 12345
  }
}
```

## Update vacancy

<mark style="color:purple;">`PATCH`</mark> `https://cruit-api.zisoo.nl/api/v1/portal/vacancy/:vacancyId`

Update new vacancy

#### Headers

| Name          | Type   | Description                |
| ------------- | ------ | -------------------------- |
| Authorization | string | JWT token in Bearer format |

#### Request Body

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| general | object |             |

{% tabs %}
{% tab title="204 " %}

```
```

{% endtab %}
{% endtabs %}

JSON Body example:

```
{
  "general": {
    "name": "Example vacancy",
    "department_id": 12345,
    "recruiting_project_id": 12345
  },
  "personal_info": {
    "email": { "enabled": false, "required": false},
    "firstname": { "enabled": true, "required": true},
    "lastname": { "enabled": true, "required": false},
    "gender": { "enabled": false, "required": false},
    "title": { "enabled": true, "required": false},
    "phone": { "enabled": true, "required": true}
  },
  "default_attachments": {
    "picture": { "enabled": true, "required": true},
    "cv": { "enabled": true, "required": true},
    "motivation": { "enabled": true, "required": true}
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://cruit-docs.zisoo.nl/portal-endpoints/vacancy.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.