{ "openapi": "3.0.3", "info": { "title": "Jobport API", "version": "1", "x-logo": { "url": "/assets/logo.png", "altText": "Jobport logo" }, "contact": { "name": "Jobport", "url": "https://jobport.nl" }, "license": { "name": "unlicensed", "url": "https://jobport.nl" } }, "servers": [ { "url": "https://api.services.jobport.nl", "description": "Production" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Introduction", "x-traitTag": true, "description": "The Jobport API provides a robust and flexible interface for managing your data in Jobport.\n\n## Standards\n\nThe Jobport API is mostly RESTful and adheres to the [JSON:API](https://jsonapi.org/) specification for consistency and interoperability.\n\nA variety of JSON:API libraries are available for most programming languages to help you interact with the API.\nThe [list of JSON API implementations](http://jsonapi.org/implementations/) is a good starting point.\n\n## Base URL\n\nUse this base URL for all requests unless instructed otherwise:\n\n```plain\nhttps://api.services.jobport.nl/public/v1/\n```\n\n## Headers\n\nSet the following HTTP headers with every request.\n\n| Header | Content |\n| ------------- | -------------- |\n| Authorization | Bearer {token} |\n\nFor more information on the Authorization header, see the [Authentication](#tag/Authentication) section.\n\nWhen POSTing or PATCHing data, also include the Content-Type header.\n\n| Parameter | Content |\n| ------------ | ---------------- |\n| Content-Type | application/json |\n\n**Example**\n\n```bash\n curl -X POST \"https://api.services.jobport.nl/public/v1/...\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\"\n```\n\n## Paths\n\nYour application may be authorized to make changes for multiple organizations. Therefore most paths are prefixed with `/organizations/{organization_id}/`, e.g. `/organizations/{organization_id}/dossiers`. When retrieving resources this will only return the resources associated with a particular organization. When creating a resource it will associate the resource with the organization.\n\nThe same applies to other nested paths, such as `/organizations/{organization_id}/dossiers/{dossier_id}/user_contexts`.\n\n## Filtering\n\nEndpoints that list resources may support filtering using the `filter[]` query parameter. This parameter accepts a list of filter values, where each value typically consists of a filter name and a value separated by a colon. Flags use only the filter name. For example: `?filter[]=active&filter[]=name:paul`. Many filters may be included multiple times to filter on multiple values, e.g. `?filter[]=name:paul&filter[]=name:john`.\n\n## Sparse fieldsets\n\nSparse fieldsets allow you to specify which fields you want to include in the response. Use the `fields` query parameter to specify a comma-separated list of fields for each resource type. For example: `?fields[dossiers]=id,name,created_at`.\n\nNote that for [export endpoints](/#tag/Export-resources) this works slightly differently: the fields must be specified without the resource type prefix. For example: `?fields=id,name,created_at`. Exports never include other resource types other than the one being exported.\n\n## Sorting\n\nEndpoints that list resources may support sorting using the `sort` query parameter. This parameter accepts a comma-separated list of field names to sort by. Prefix a field name with a minus sign (`-`) to sort in descending order. For example: `?sort=name,-created_at`.\n\nAvailable sorting options vary by endpoint and are documented in each endpoint’s documentation.\n\n## Meta data\n\nWhen retrieving a list of resources, the response will include a top level `meta` object containing additional information about the response, such as pagination details (`page`, `page_size`).\n\nEndpoints that list resources support optional inclusion of the total count of resources in the `meta` object.\nUse the `_count` query parameter to do so. For example: `?_count=true`. The `meta` object will include a `total` field indicating the total number of resources available, regardless of any filters applied.\n\nNote that [export endpoints](/#tag/Export-resources) do not return a `meta` object, as they are designed to export all available data without pagination.\n\n## User contexts\n\nJobport allows a single user to have access to multiple contexts across different organizations. For example, a person can be a coach for organization 'A' and 'B', and also be a client coached by organization 'C'. This user would have three user contexts. If a user has multiple contexts, they can switch between them without logging out and back in.\n\n**Storing user contexts**\n\nA user context ID is permanent and reused even after deactivation and reactivation. If your app stores these IDs (e.g. for SSO), note that inactive contexts may return a 404 when accessed.\n\n## Bugs & suggestions\n\nIf you encounter issues with the API, or want to suggest improvements, please let us know at [https://www.jobport.nl/contact](https://www.jobport.nl/contact).\n" }, { "name": "Authentication", "x-traitTag": true, "description": "Your application must send a self-generated short-lived JSON Web Token (JWT) with each request you send to the API. This token identifies your application with a digital signature.\n\n\n\n## Creating a signed token\n\nTo create signed JWTs, you will receive from us:\n\n- A unique ID to identify your application (referred to as the *app_id*)\n- A shared secret to sign the JWTs (keep this confidential)\n\nTo request these credentials for your application, contact us at https://www.jobport.nl/contact. API access is available for selected customers only. Please provide the name of your application and describe the purpose of the integration you are building. We will then review your request. When eligible we will create an application for you with the appropriate permissions and provide you with the necessary credentials.\n\nA signed JWT has three parts: a header, a payload, and a signature. Do __not__ base64-encode the secret when generating the token. You can reuse a token until it expires or generate a new one for each request. The latter might be simpler to manage and could increase security by limiting the token's lifetime (see `exp` below).\n\nThe header __must__ contain:\n\nProperty | Type | Required | Value\n----------- | ---------- |----------- | -----------\nalg | string | true | \"HS256\"\ntyp | string | true | \"JWT\"\n\nThe payload __must__ contain:\n\nClaim | Type | Required | Description\n----------- | ---------- |----------- | -----------\napp_id | string | true | This is the application id you received along with your shared secret\nexp | integer | true | Expiration date in seconds since Unix Epoch, not more than 15 minutes in the future\n\nMost programming languages have libraries available to help you create signed JWTs. Basically, it takes three steps:\n\n1. `token = base64UrlEncode(header) + \".\" + base64UrlEncode(payload)`\n2. `signature = HMACSHA256(token, shared_secret)`\n3. `signed_token = token + \".\" + signature`\n\nYou can use [https://jwt.io](https://jwt.io) to check if your JWTs are valid and contain the correct data. Never enter your shared secret into third party tools. If you need to do that, please request another shared secret for production use once you have authentication set up.\n\n**Example**\n\n```ruby\n# Assume we want our example JWT to contain the following header and payload:\nheader = { \"alg\": \"HS256\", \"typ\": \"JWT\" }\npayload = { \"app_id\": \"673943a3-8df4-421d-ad5b-34e747cadd83\", \"exp\": 1505487093 }\n\n# We then encode and combine the parts:\ntoken = base64UrlEncode(header) + \".\" + base64UrlEncode(payload) # => eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBfaWQiOiI2NzM5NDNhMy04ZGY0LTQyMWQtYWQ1Yi0zNGU3NDdjYWRkODMiLCJleHAiOjE1MDU0ODcwOTN9\n\n# Then calculate the signature:\nshared_secret = `your-256-bit-secret`\nsignature = HMACSHA256(token, shared_secret) # => SSqSQeVlLjqdrm5cPqTcXLwaq_w7UJmsWJZ8oDCPJ_g\n\n# Finally, append the signature to get your signed JWT:\nsigned_token = token + \".\" + signature # => eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBfaWQiOiI2NzM5NDNhMy04ZGY0LTQyMWQtYWQ1Yi0zNGU3NDdjYWRkODMiLCJleHAiOjE1MDU0ODcwOTN9.SSqSQeVlLjqdrm5cPqTcXLwaq_w7UJmsWJZ8oDCPJ_g\n```\n\n## What if I cannot generate a JWT?\n\nIf you’re unable to generate a JWT dynamically, we can provide a static, long-lived token for authenticating your requests. However, we strongly recommend using short-lived JWTs for better security. To request a static token, [contact us](https://www.jobport.nl/contact). Keep static tokens confidential. They must be renewed annually.\n\n## Using the token to authenticate\n\nSet the `Authorization` header with the value `Bearer {signed_token}` in every request you make to the API.\n\n**Example**\n\n```shell\ncurl \"https://api.services.jobport.nl/...\" \\\n -H \"Authorization: Bearer $SIGNED_TOKEN\"\n```\n\n## User tokens\n\nUse the [token exchange endpoint](#tag/User-Tokens/operation/create_user_token) when your application needs to perform actions on behalf of a user.\n\n## Single Sign-On (SSO)\n\nUse the [one-time SSO URL endpoint](#tag/One-time-SSO-URLs/operation/create_one_time_sso_url) to create a short-lived SSO URL that your user can use to log in to Jobport.\n" }, { "name": "One-time SSO URLs", "description": "Jobport supports SSO with secure, one-time URLs for one specific user context. The URL can be used only once and expires within seconds after creation. Request the SSO URL just before the user needs to log in, then redirect them immediately.\n\nA user may belong to multiple organizations. After logging in with an SSO URL, the user will only have access to the organization for which the SSO URL was generated. This prevents unauthorized access to other organizations.\n" }, { "name": "Conversations", "description": "Endpoints for retrieving conversations." }, { "name": "Notifications", "description": "Endpoints for retrieving notifications." }, { "name": "User Tokens", "description": "Endpoints for retrieving user tokens." }, { "name": "User Contexts", "description": "Endopoints for retrieving user contexts." }, { "name": "Dossiers", "description": "Endpoints for managing dossiers.\nDossiers hold information about a candidate. Once a dossier exists you can (optionally) invite the candidate to create a Jobport account." }, { "name": "Employer Vacancies", "description": "Endpoints for managing employer vacancies." }, { "name": "Contacts", "description": "Endpoints for managing contacts." }, { "name": "Employers", "description": "Endpoints for retrieving employers." }, { "name": "Saved Vacancies", "description": "Endpoints for retrieving saved vacancies." }, { "name": "Custom Fields", "description": "Endpoints for managing custom fields." }, { "name": "Exported formats", "x-traitTag": true, "description": "Endpoints in this section are designed to export data from Jobport. E.g., without pagination. These are commonly used for integration with business intelligence systems.\n\nData can be exported in either JSON:API format or CSV format.\n\nUse the `Accept` header to specify the desired format:\n- `application/json` for JSON:API\n- `text/csv` for CSV\n\nAlternatively, you can use an extension in the URL to specify the format: append `.json` or `.csv`.\n\n## CSV\n\nThe CSV format includes a column for the resource ID and for each other attribute and relationship that is also included in the JSON:API format. Refer to the JSON:API documentation for details on the included attributes and relationships.\n\nThe CSV contains a header row with the attribute names, where nested attributes are expanded into separate columns using dot notation (e.g., `access.granted_at`, `access.revoked_at`). If your BI system has trouble interpreting dot notation, you can use the `underscorize_headers` query parameter to change the naming convention:\n\n```bash\ncurl \"https://api.services.jobport.nl/public/v1/organizations/{organization_id}/exports/dossiers?underscorize_headers=1\" \\\n -H \"Accept: text/csv\"\n```\n\nNow dots will be replaced with double underscores (e.g., `access__granted_at`, `access__revoked_at`).\n\nRelationships have columns named after the relationship, such as `profile`, `employers`, etc. Related resources are refered to by their type and id using colon-separated identifiers, e.g., `profiles:f5e3509e-7e3e-4ecf-a8cf-06e2b0f7830d`. In case of one-to-many relationships, the identifiers are joined into a single column and separated by commas, e.g., `employers:af4ca214-86af-4cc9-9259-b7bc6b545bed7,employers:266c496c-3f86-418b-8ebf-d123316300f5`.\n\n**Example CSV (contacts)**\n\n```csv\nid,access.granted_at,access.last_activity_at,access.revoked_at,access.status,archived_at,created_at,email,name,phone_number,employer\n8fd21a5b-0fc0-43dc-8ab2-4e668c7d1d11,2023-10-01T12:00:00Z,2023-10-01T12:00:00Z,,active,,2023-10-01T11:59:59Z,johndoe@example.org,John Doe,+31612345678,employers:656f088a-aadc-44e1-99b0-00b6f07a3ed4\n```\n\nAlso see the [CSV columns overview](/csv-overview.html) for a complete overview of exported columns per resource type.\n" }, { "name": "Export resources", "description": "Endpoints for exporting resources." }, { "name": "Export taxonomy", "description": "Endpoints for exporting taxonomy data." }, { "name": "Changelog", "x-traitTag": true, "description": "## Export endpoints\n\n**November 5, 2025**\nEndpoint | Change | Description\n--- | --- | ---\n[EmployerVacancies](/#tag/Export-resources/operation/export_employer_vacancies) | Attribute(s) added | Attributes `work_types`, `work_styles`, `accessible_by_public_transport`, `driving_licenses`, `work_environments`, `transport_modes`, `work_schedules`, `number_of_seats`, `foreign_languages`, and `language_nl` (with nested `reading`, `writing`, `speaking`, `understanding`) have been added.\n\n**August 18, 2025**\nEndpoint | Change | Description\n--- | --- | ---\n[EmployerVacancies](/#tag/Export-resources/operation/export_employer_vacancies) | Relationship attribute(s) added | Relationship `account_manager` is added.\n\n**July 15, 2025**\nEndpoint | Change | Description\n--- | --- | ---\n[Employers](/#tag/Export-resources/operation/export_employers) | Attribute(s) added | Attributes `branch_total_employees`, `total_employees`, `legal_form` and `sbi_codes` have been added.\n\n**June 23, 2025**\n\nEndpoint | Change | Description\n--- | --- | ---\nExport endpoints | Attribute(s) added | Added columns that include the type and id for each related resource. E.g. for a (polymorphic) relationship with a subject there now is a `subject` column with a value like `employers:af4ca214-86af-4cc9-9259-b7bc6b545bed7`. See CSV documentation on relationships.\nExport endpoints | Attribute(s) removed | All id-only columns for related resources have been deprecated* in favor of new columns that include resource types. E.g. a relationship with a subject, was listed in the CSV as a `subject.id` field. From now on you should use the `subject` field instead.\n[Notes](/#tag/Export-resources/operation/export_notes) | Attribute(s) removed | Attributes `author.type` and `subject.type` have been deprecated* in favor of `author` and `subject`.\n\n**March 14, 2025**\n\nEndpoint | Change | Description\n--- | --- | ---\n[Placements](/#tag/Export-resources/operation/export_placements) | Endpoint added | Added export placements endpoint.\n\n**March 9, 2025**\n\nEndpoint | Change | Description\n--- | --- | ---\n[Dossiers](/#tag/Export-resources/operation/export_dossiers) | Attribute(s) added | Attribute `delete_scheduled_at` has been added to indicate when an archived dossier will be automatically deleted.\n\n**March 3, 2025**\n\nEndpoint | Change | Description\n--- | --- | ---\n[Employers](/#tag/Export-resources/operation/export_employers) | Attribute(s) added | Attributes `primary_account_manager` and `account_managers` have been added.\n[Employers](/#tag/Export-resources/operation/export_employers) | Attribute(s) removed | Attribute `account_manager` has been deprecated* in favor of `primary_account_manager` and `account_managers`.\n\n**March 1, 2025**\n\n| Change | Description |\n--- | ---\n| Changelog added | Added this changelog to the documentation. |\n\n---\n\n\\* In most cases, deprecated attributes will remain available in exports for at least six months.\n" } ], "paths": { "/public/v1/organizations/{organization_id}/tokens": { "post": { "operationId": "create_user_token", "summary": "Create User Token", "description": "With this endpoint an OpenID id_token or access_token can be exchanged for a JWT token that authenticates as a user. It can be used to perform impersonated requests.\n\nThis is only allowed for identity providers that have been specifically whitelisted for your organization.\n\nThis endpoint follows the [standard OAuth2 token exchange specification](https://www.rfc-editor.org/rfc/rfc8693.html#name-token-exchange-request-and-).\n", "tags": [ "User Tokens" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "requestBody": { "$ref": "#/components/requestBodies/body" }, "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/user_contexts/{user_context_id}/sso/one_time_url": { "post": { "operationId": "create_one_time_sso_url", "summary": "Create One-time SSO URL", "description": "Create a short-lived one-time SSO URL for a user context.\n", "tags": [ "One-time SSO URLs" ], "parameters": [ { "$ref": "#/components/parameters/user_context_id" }, { "$ref": "#/components/parameters/organization_id" } ], "responses": { "201": { "$ref": "#/components/responses/created" }, "400": { "$ref": "#/components/responses/bad_request-2" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found-2" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/user_contexts/{user_context_id}": { "get": { "operationId": "get_organization_user_context", "summary": "Get User Context", "description": "Returns a single user context for the specified organization.\n", "tags": [ "User Contexts" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/user_context_id-2" } ], "responses": { "200": { "$ref": "#/components/responses/ok-2" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "User context not found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/dossiers": { "get": { "operationId": "list_organization_dossiers", "summary": "List Dossiers", "description": "Returns a list of dossiers for the specified organization.\n", "tags": [ "Dossiers" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/_count" } ], "responses": { "200": { "$ref": "#/components/responses/ok-3" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "create_organization_dossier", "summary": "Create Dossier", "description": "Creates a new dossier for the specified organization.\n", "tags": [ "Dossiers" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dossiers" ] }, "attributes": { "type": "object", "properties": { "administration_number": { "type": "string", "description": "Administrative identification number which can be used to retrieve the dossier of the candidate later on.", "example": "123456789" }, "archive_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date/time when the dossier should be archived. The candidate loses access to the dossier after this date.", "example": "2025-06-30T12:00:00Z" }, "email": { "type": "string", "format": "email", "description": "Email address of the candidate.", "example": "candidate@example.com" }, "name": { "type": "string", "description": "Name of the candidate.", "example": "John Doe" }, "send_invitation_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date/time when an invitation email should be sent to the candidate.", "example": "2025-06-15T09:00:00Z" }, "postal_code": { "type": "string", "description": "Dutch postal code of the candidate's address.", "example": "1234AB" } } }, "relationships": { "type": "object", "properties": { "track": { "type": "object", "properties": { "data": { "type": "object", "description": "The track for a dossier. The track defines a.o. the intake and tests that a candidate will get.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the track.", "example": "66009647-d0ae-438a-af37-4cd9b64c64b0" }, "type": { "type": "string", "example": "tracks" } } } } }, "coaches": { "type": "object", "description": "The memberships of the employees that coach the candidate associated with this dossier. Required unless the track defines a 'default coach'. Currently only 1 coach is supported.", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the membership.", "example": "8faf1298-bad5-40c6-96a0-d87fe65938bd" }, "type": { "type": "string", "example": "memberships" } } } } } } } } }, "required": [ "type", "attributes" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true, "description": "Form-encoded request body" } } } }, "responses": { "201": { "$ref": "#/components/responses/created-2" }, "400": { "description": "Invalid request body." }, "401": { "$ref": "#/components/responses/unauthorized" }, "402": { "description": "Payment required - subscription limit reached." }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found-2" }, "422": { "$ref": "#/components/responses/unprocessable_content" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/dossiers/{dossier_id}": { "get": { "operationId": "get_organization_dossier", "summary": "Get Dossier", "description": "Returns a single dossier for the specified organization by dossier ID.\n", "tags": [ "Dossiers" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/dossier_id" } ], "responses": { "200": { "$ref": "#/components/responses/ok-4" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Dossier not found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/dossiers/{dossier_id}/user_contexts": { "post": { "operationId": "create_organization_dossier_user_context", "summary": "Create User Context", "description": "Create a user context for a dossier with a custom identity provider login.\n\nTypically, when a candidate needs access to Jobport, they receive an invitation email to create an account (using the `send_invitation_at` attribute). If your organization uses a custom identity provider, you can create a user account for the candidate directly, bypassing the standard invitation process. This allows account creation without candidate interaction. Note: This also means the candidate will not see or agree to any terms and conditions, which are usually presented during signup. This endpoint creates a user (or assigns an existing user) to a dossier based on the provider identity identifier. After a successful request, the candidate can log in using the identity provider. This is only possible if no user has previously been created for the dossier. Changing provider identity details after creation is not supported.\n", "tags": [ "Dossiers" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/dossier_id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user_contexts" ] }, "attributes": { "type": "object", "properties": { "provider_id": { "type": "string", "description": "The id of your custom identity provider (as provided by Jobport)", "example": "custom_provider" }, "provider_identity_identifier": { "type": "string", "description": "The identifier of the identity from the provider. E.g., an email address or social security number.", "example": "123456789" } }, "required": [ "provider_id", "provider_identity_identifier" ] } }, "required": [ "type", "attributes" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "201": { "$ref": "#/components/responses/created-3" }, "400": { "description": "Invalid request body" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found-2" }, "422": { "$ref": "#/components/responses/unprocessable_content" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/employer_vacancies": { "get": { "operationId": "list_organization_employer_vacancies", "summary": "List Employer Vacancies", "description": "Returns a list of employer vacancies for the specified organization.\n", "tags": [ "Employer Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/_count" } ], "responses": { "200": { "$ref": "#/components/responses/ok-5" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Organization not found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "create_organization_employer_vacancy", "summary": "Create Employer Vacancy", "description": "Create an employer vacancy for the specified organization.\n", "tags": [ "Employer Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/type" }, "attributes": { "$ref": "#/components/schemas/attributes" }, "relationships:": { "$ref": "#/components/schemas/relationships" } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true, "description": "Form-encoded request body" } } } }, "responses": { "201": { "$ref": "#/components/responses/ok-6" }, "400": { "description": "Invalid request body." }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Organization not found" }, "422": { "$ref": "#/components/responses/unprocessable_content" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/employer_vacancies/{employer_vacancy_id}": { "get": { "operationId": "get_organization_employer_vacancy", "summary": "Get Employer Vacancy", "description": "Returns a single employer vacancy for the specified organization by employer vacancy ID.\n", "tags": [ "Employer Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/employer_vacancy_id" } ], "responses": { "200": { "$ref": "#/components/responses/ok-6" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Employer vacancy not found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "operationId": "update_organization_employer_vacancy", "summary": "Update Employer Vacancy", "description": "Update a single employer vacancy for the specified organization by employer vacancy ID.\n", "tags": [ "Employer Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/employer_vacancy_id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/type" }, "attributes": { "type": "object", "description": "Employer vacancy attributes.", "properties": { "contact_through": { "nullable": true, "type": "string", "enum": [ "account_manager", "employer", null ], "description": "Who to get in touch with regarding this vacancy.", "example": "account_manager" }, "title": { "type": "string", "description": "The title of the vacancy.", "example": "Klantgerichte medewerker gezocht voor de klantenservice" }, "postal_code": { "type": "string", "nullable": true, "description": "The postal code where the vacancy is located. Must be a valid Dutch postal code. Letters may be omitted.", "pattern": "^[1-9]\\d{3}(\\s?[a-zA-Z]{2})?$", "example": "5611 AZ" }, "city": { "type": "string", "description": "The city where the vacancy is located.", "example": "Amsterdam" }, "education_level": { "type": "string", "nullable": true, "description": "Education level for the vacancy.", "enum": [ "basic_education", "vmbo", "havo_vwo", "mbo_1", "mbo_2", "mbo_3", "mbo_4", "hbo", "wo_master", null ] }, "hours_per_week_max": { "type": "integer", "nullable": true, "description": "Maximum number of hours per week for the vacancy.", "maximum": 40, "example": 40 }, "hours_per_week_min": { "type": "integer", "nullable": true, "description": "Minimum number of hours per week for the vacancy. Not greater than hours_per_week_max.", "minimum": 0, "example": 32 }, "starts_at": { "type": "string", "format": "date", "description": "When the vacancy has been opened.", "example": "2025-01-01" }, "ends_at": { "type": "string", "format": "date", "description": "When the vacancy closes.", "example": "2025-06-30" }, "description": { "type": "string", "description": "A detailed description of the vacancy. Markdown is supported. HTML input is sanitized (unsupported tags removed) and converted to Markdown.", "example": "We zoeken een enthousiaste _medewerker klantenservice_ die ons team komt versterken." }, "external_url": { "type": "string", "format": "uri", "nullable": true, "description": "External URL where candidates can view and apply for the vacancy.", "example": "https://example.com/vacatures/software-engineer" }, "published": { "type": "boolean", "description": "Indicates whether the vacancy is currently published.", "example": true }, "work_types": { "type": "array", "items": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "description": "RIASEC work types associated with the vacancy.", "example": [ "social", "conventional" ] }, "archived": { "type": "boolean", "description": "Indicates whether the vacancy is archived. Set to false to unarchive the vacancy.", "example": false }, "custom_fields": { "type": "object", "description": "Custom field values for the vacancy. Keys are field codes and values are the corresponding field\nvalues. Value types and restrictions depend on the custom field definition. Custom field definitions\ncan be retrieved using the custom fields endpoint.\n\nThe object will be merged with existing custom fields on updates. If a field is not present in the\nupdate request, it will not be modified.\n", "example": { "pay_grade": 10 } } } }, "relationships": { "type": "object", "properties": { "employer": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The employer associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the employer.", "example": "c888a1fd-de7c-430a-8f83-19c6bfa8105b" }, "type": { "type": "string", "enum": [ "employers" ] } } } } }, "contact": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The contact associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact.", "example": "6360dbc8-987b-4b20-8928-ae6f950d8008" }, "type": { "type": "string", "enum": [ "contacts" ] } } } } }, "contact_management": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The manager contact associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact.", "example": "6360dbc8-987b-4b20-8928-ae6f950d8008" }, "type": { "type": "string", "enum": [ "contacts" ] } } } } }, "contact_recruitment": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The recruiter contact associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact.", "example": "6360dbc8-987b-4b20-8928-ae6f950d8008" }, "type": { "type": "string", "enum": [ "contacts" ] } } } } } } } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true, "description": "Form-encoded request body" } } } }, "responses": { "200": { "$ref": "#/components/responses/ok-6" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Employer vacancy not found" }, "422": { "$ref": "#/components/responses/unprocessable_content" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "operationId": "delete_organization_employer_vacancy", "summary": "Delete Employer Vacancy", "description": "Delete a single employer vacancy for the specified organization by employer vacancy ID.\n", "tags": [ "Employer Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/employer_vacancy_id" } ], "responses": { "204": { "$ref": "#/components/responses/no_content" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Employer vacancy not found" }, "422": { "$ref": "#/components/responses/unprocessable_content" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/contacts": { "get": { "operationId": "list_organization_contacts", "summary": "List Contacts", "description": "Returns a list of contacts for the specified organization.\n", "tags": [ "Contacts" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/filter-2" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/_count" } ], "responses": { "200": { "$ref": "#/components/responses/ok-7" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Organization not found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "create_organization_contact", "summary": "Create Contact", "description": "Create a contact for the specified organization.\n", "tags": [ "Contacts" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/type-2" }, "attributes": { "$ref": "#/components/schemas/attributes-2" }, "relationships": { "$ref": "#/components/schemas/relationships-2" } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true, "description": "Form-encoded request body" } } } }, "responses": { "201": { "$ref": "#/components/responses/ok-8" }, "400": { "description": "Invalid request body." }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Organization not found" }, "422": { "$ref": "#/components/responses/unprocessable_content" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/contacts/{contact_id}": { "get": { "operationId": "get_organization_contact", "summary": "Get Contact", "description": "Returns a single contact for the specified organization by contact ID.\n", "tags": [ "Contacts" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/contact_id" } ], "responses": { "200": { "$ref": "#/components/responses/ok-8" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Contact not found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "operationId": "update_organization_contact", "summary": "Update Contact", "description": "Update a single contact for the specified organization by contact ID.\n", "tags": [ "Contacts" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/contact_id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/type-2" }, "attributes": { "type": "object", "description": "Contact attributes.", "properties": { "email": { "type": "string", "format": "email", "nullable": true, "description": "The contact's correspondence email address.", "example": "jane.doe@example.com" }, "name": { "type": "string", "description": "The full name of the contact.", "example": "Jane Doe" }, "notes": { "type": "string", "nullable": true, "description": "Additional notes about the contact.", "example": "Prefers to be contacted by email." }, "phone_number": { "type": "string", "nullable": true, "description": "The contact's phone number. Must be 7 to 15 digits. May include spaces, dashes, and dots as separators, parentheses for grouping (must be closed and not nested), and a leading plus sign.", "example": "+31 (0) 6 1234 5678" }, "archived": { "type": "boolean", "description": "Whether the contact is archived. Set to false to unarchive the contact.", "example": false } } }, "relationships": { "type": "object", "description": "Contact relationships.", "properties": { "employer": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The employer associated with the contact.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the employer.", "example": "c888a1fd-de7c-430a-8f83-19c6bfa8105b" }, "type": { "type": "string", "enum": [ "employers" ] } } } } } } } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true, "description": "Form-encoded request body" } } } }, "responses": { "200": { "$ref": "#/components/responses/ok-8" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Contact not found" }, "422": { "$ref": "#/components/responses/unprocessable_content" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "operationId": "delete_organization_contact", "summary": "Delete Contact", "description": "Delete a single contact for the specified organization by contact ID.\n", "tags": [ "Contacts" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/contact_id" } ], "responses": { "204": { "$ref": "#/components/responses/no_content" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Contact not found" }, "422": { "$ref": "#/components/responses/unprocessable_content" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/employers": { "get": { "operationId": "list_organization_employers", "summary": "List Employers", "description": "Returns a list of employers for the specified organization.\n", "tags": [ "Employers" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/filter-3" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/_count" } ], "responses": { "200": { "$ref": "#/components/responses/ok-9" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Organization not found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/dossiers/{dossier_id}/saved_vacancies": { "get": { "operationId": "list_organization_dossier_saved_vacancies", "summary": "List Saved Vacancies", "description": "Returns a list of saved vacancies for the specified organization and dossier.\n", "tags": [ "Saved Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/dossier_id" }, { "$ref": "#/components/parameters/filter-4" }, { "$ref": "#/components/parameters/include" } ], "responses": { "200": { "$ref": "#/components/responses/ok-10" }, "400": { "$ref": "#/components/responses/bad_request-2" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found-2" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/saved_vacancies/{saved_vacancy_id}": { "get": { "operationId": "get_saved_vacancy", "summary": "Get Saved Vacancy", "description": "Returns a single saved vacancy.\n", "tags": [ "Saved Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/saved_vacancy_id" }, { "$ref": "#/components/parameters/include" } ], "responses": { "200": { "$ref": "#/components/responses/ok-11" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found-2" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/dossiers/{dossier_id}/saved_vacancies/activities": { "get": { "operationId": "list_organization_dossier_saved_vacancies_activities", "summary": "List Activities", "description": "Returns a list of saved vacancy activities for the specified organization and dossier.\n", "tags": [ "Saved Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/dossier_id" }, { "$ref": "#/components/parameters/filter-5" }, { "$ref": "#/components/parameters/sort" } ], "responses": { "200": { "$ref": "#/components/responses/ok-12" }, "400": { "$ref": "#/components/responses/bad_request-2" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found-2" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/dossiers/{dossier_id}/saved_vacancies/{saved_vacancy_id}/activities": { "get": { "operationId": "list_organization_dossier_saved_vacancy_activities", "summary": "List Saved Vacancy Activities", "description": "Returns a list of activities for the specified saved vacancy.\n", "tags": [ "Saved Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/dossier_id" }, { "$ref": "#/components/parameters/saved_vacancy_id-2" }, { "$ref": "#/components/parameters/filter-5" }, { "$ref": "#/components/parameters/sort" } ], "responses": { "200": { "$ref": "#/components/responses/ok-12" }, "400": { "$ref": "#/components/responses/bad_request-2" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found-2" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/vacancy_states": { "get": { "operationId": "list_vacancy_state", "summary": "List Vacancy States", "description": "Retrieve vacancy states.\n", "tags": [ "Saved Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/_count" } ], "responses": { "200": { "$ref": "#/components/responses/ok-13" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/vacancy_states/{vacancy_state_id}": { "get": { "operationId": "get_vacancy_state", "summary": "Get Vacancy State", "description": "Returns a single Vacancy State\n", "tags": [ "Saved Vacancies" ], "parameters": [ { "$ref": "#/components/parameters/vacancy_state_id" } ], "responses": { "200": { "$ref": "#/components/responses/ok-14" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Vacancy state not found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/tracks": { "get": { "operationId": "list_organization_tracks", "summary": "List Tracks", "description": "Returns a list of tracks for the specified organization.\n", "tags": [ "Tracks" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/_count" } ], "responses": { "200": { "$ref": "#/components/responses/ok-15" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/tracks/{track_id}": { "get": { "operationId": "get_organization_track", "summary": "Get Track", "description": "Returns a single track for the specified organization by track ID.\n", "tags": [ "Tracks" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/track_id" } ], "responses": { "200": { "$ref": "#/components/responses/ok-16" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Dossier not found" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/user_contexts/{user_context_id}/conversations": { "get": { "operationId": "list_user_context_conversations", "summary": "List Conversations", "description": "Returns a list of conversations for the specified user context.\n", "tags": [ "Conversations" ], "parameters": [ { "$ref": "#/components/parameters/user_context_id-2" }, { "$ref": "#/components/parameters/filter-6" }, { "$ref": "#/components/parameters/sort-2" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/_count" }, { "$ref": "#/components/parameters/x_request_id" } ], "responses": { "200": { "$ref": "#/components/responses/ok-17" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/user_contexts/{user_context_id}/conversations/{conversation_id}": { "get": { "operationId": "get_user_context_conversation", "summary": "Get Conversation", "description": "Returns a single conversation for the specified user context.\n", "tags": [ "Conversations" ], "parameters": [ { "$ref": "#/components/parameters/user_context_id-2" }, { "$ref": "#/components/parameters/conversation_id" }, { "$ref": "#/components/parameters/x_request_id" } ], "responses": { "200": { "$ref": "#/components/responses/ok-18" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found-2" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/user_contexts/{user_context_id}/notifications": { "get": { "operationId": "list_user_context_notifications", "summary": "List Notifications", "description": "Returns a list of notifications for the specified user context.\n", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/user_context_id-2" }, { "$ref": "#/components/parameters/filter-7" }, { "$ref": "#/components/parameters/sort-3" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/_count" }, { "$ref": "#/components/parameters/x_request_id" } ], "responses": { "200": { "$ref": "#/components/responses/ok-19" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/user_contexts/{user_context_id}/notifications/{notification_id}": { "get": { "operationId": "get_user_context_notification", "summary": "Get Notification", "description": "Returns a single notification for the specified user context.\n", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/user_context_id-2" }, { "$ref": "#/components/parameters/notification_id" }, { "$ref": "#/components/parameters/x_request_id" } ], "responses": { "200": { "$ref": "#/components/responses/ok-20" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found-2" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/custom_fields": { "get": { "operationId": "list_organization_custom_fields", "summary": "List Custom Fields", "description": "Returns a list of custom fields for the specified organization.\n", "tags": [ "Custom Fields" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" }, { "$ref": "#/components/parameters/filter-8" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/_count" } ], "responses": { "200": { "$ref": "#/components/responses/ok-21" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/exports/dossiers": { "get": { "operationId": "export_dossiers", "summary": "Dossiers", "description": "Export dossiers of an organization.\n", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_dossiers" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/exports/profiles": { "get": { "operationId": "export_profiles", "summary": "Profiles", "description": "Export profiles of an organization.\n", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_profiles" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/exports/profiles/educations": { "get": { "operationId": "export_educations", "summary": "Educations", "description": "Export educations used in profiles of an organization.\n", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_educations" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/exports/members": { "get": { "operationId": "export_members", "summary": "Members", "description": "Export members of an organization.\n", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_members" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/exports/taxonomy/sectors": { "get": { "operationId": "export_taxonomy_sectors", "summary": "Sectors", "description": "Export sectors.\n", "tags": [ "Export taxonomy" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_taxonomy_sectors" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/exports/taxonomy/occupations": { "get": { "operationId": "export_taxonomy_occupations", "summary": "Occupations", "description": "Export occupations.\n", "tags": [ "Export taxonomy" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_taxonomy_occupations" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/exports/contacts": { "get": { "operationId": "export_contacts", "summary": "Contacts", "description": "Export contacts of an organization.", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_contacts" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/public/v1/organizations/{organization_id}/exports/notes": { "get": { "operationId": "export_notes", "summary": "Notes", "description": "Export notes of an organization.", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_notes" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/public/v1/organizations/{organization_id}/exports/placements": { "get": { "operationId": "export_placements", "summary": "Placements", "description": "Export placements for an organization.", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_placements" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/public/v1/organizations/{organization_id}/exports/employer_vacancies": { "get": { "operationId": "export_employer_vacancies", "summary": "Employer Vacancies", "description": "Export employer vacancies of an organization.\n", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_employer_vacancies" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/public/v1/organizations/{organization_id}/exports/employer_vacancy_dossiers": { "get": { "operationId": "export_employer_vacancy_dossiers", "summary": "Employer Vacancy Dossiers", "description": "Export employer vacancy dossiers for an organization.\n", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_employer_vacancy_dossiers" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/exports/showrooms": { "get": { "operationId": "export_showrooms", "summary": "Showrooms", "description": "Export showrooms for an organization.", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_showrooms" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/public/v1/organizations/{organization_id}/exports/employers": { "get": { "operationId": "export_employers", "summary": "Employers", "description": "Export employers of an organization.\n", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_employers" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/v1/organizations/{organization_id}/exports/tasks": { "get": { "operationId": "export_tasks", "summary": "Tasks", "description": "Export tasks of an organization.", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_tasks" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/public/v1/organizations/{organization_id}/exports/tracks": { "get": { "operationId": "export_tracks", "summary": "Tracks", "description": "Export tracks for an organization.\n", "tags": [ "Export resources" ], "parameters": [ { "$ref": "#/components/parameters/organization_id" } ], "responses": { "200": { "$ref": "#/components/responses/export_tracks" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/server_error" } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "The Jobport JWT token" } }, "parameters": { "organization_id": { "in": "path", "name": "organization_id", "description": "The ID of the organization.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "user_context_id": { "in": "path", "name": "user_context_id", "description": "The ID of the user context.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "687ae300-3f3f-46e3-a204-3add97f82165" }, "user_context_id-2": { "in": "path", "name": "user_context_id", "description": "The ID of the user context.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "filter": { "in": "query", "name": "filter[]", "description": "Filters to query specific dossiers.\n\nFilter | Type | Description | Example value\n------ | ---- | ----------- | -------------\nemail | `string` | Filters by one or more exact email addresses (case insensitive) | email:john.doe@example.org\nq | `string` | Filters by search query | q:doe\n", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "email:john.doe@example.org", "email:jane.doe@example.org" ] }, "page": { "in": "query", "name": "page", "description": "The requested page for paginated responses.\n", "schema": { "type": "integer", "default": 1 } }, "page_size": { "in": "query", "name": "page_size", "description": "The requested amount of items for paginated responses.\n", "schema": { "type": "integer", "default": 20 } }, "_count": { "in": "query", "name": "_count", "description": "Flag to receive total count in the response, value is irrelevant.\n", "schema": { "type": "string", "example": "true" } }, "dossier_id": { "name": "dossier_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the dossier", "example": "190d972c-e522-473a-8fb9-0d23f9283045" }, "employer_vacancy_id": { "name": "employer_vacancy_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the employer vacancy", "example": "82b4b296-ccf6-45c5-917c-ae95ee8c9a9b" }, "filter-2": { "in": "query", "name": "filter[]", "description": "Filters to query specific contacts.\n\n| Filter | Type | Description | Example value |\n| ------ | ---- | ----------- | ------------- |\n| archived | `boolean` | Only return contacts that are either archived or not archived. | archived:false |\n| email | `string` | Only return contacts with the given email address(es). | email:jane.doe@example.org |\n| employer | `string` | Only return contacts belonging to one or more employers by ID. | employer:1c595214-fc27-4528-915e-ad73f7d3b5c5 |\n| q | `string` | Filters by search query, searches name and email. | q:doe |\n", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "q:doe", "archived:false" ] }, "contact_id": { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the contact", "example": "7dd42af8-9bf2-4a53-820c-837d1cc49ea6" }, "filter-3": { "in": "query", "name": "filter[]", "description": "Filters to query specific employers.\n\n| Filter | Type | Description | Example value |\n| ------ | ---- | ----------- | ------------- |\n| name | `string` | Only return employers with the given name(s). | name:Jobport |\n| national_id | `string` | Only return employers with the given national identifier(s) (KVK number). | national_id:12345678 |\n| national_branch_id | `string` | Only return employers with the given national branch identifier(s) (KVK branch number). | national_branch_id:123456789012 |\n| archived | `boolean` | Only return employers that are either archived or not archived. | archived:false |\n", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "name:Jobport", "archived:false" ] }, "filter-4": { "in": "query", "name": "filter[]", "description": "Filters to query specific saved vacancies.\n\nFilter | Type | Description | Example value\n------ | ---- | ----------- | -------------\nrecent_activity | `flag` | List only vacancies with activity during the last month.
If today would be March 16, this would return vacancies with activity on or after Februari 16. | recent_activity\nvacancy_type | `string` | List only saved vacancies of a specific type.
Possible values: `external` | vacancy_type:external\n", "schema": { "type": "array", "items": { "type": "string" }, "example": [ "recent_activity", "vacancy_type:external" ] } }, "include": { "name": "include[]", "in": "query", "description": "Include related resources in the response.\n", "schema": { "type": "array", "items": { "type": "string", "enum": [ "vacancy", "vacancy_state" ] } }, "example": [ "vacancy", "vacancy_state" ] }, "saved_vacancy_id": { "name": "saved_vacancy_id", "in": "path", "required": true, "description": "The ID of the saved vacancy to retrieve.", "schema": { "type": "string", "example": "5be31c5a-d46b-497d-83c1-69a9dd40147b" } }, "filter-5": { "in": "query", "name": "filter[]", "description": "Filters to query specific activities.\n\n| Filter | Type | Description | Example value |\n| ------ | ---- | ----------- | ------------- |\n| after | `date` | Only return activities after this date (RFC-3339). | after:2024-01-01 |\n| before | `date` | Only return activities before this date (RFC-3339). | before:2024-12-31 |\n| vacancy_type | `string` | Only return activities for this vacancy type.
Possible values: `external` | vacancy_type:external |\n", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "after:2024-01-01", "vacancy_type:external" ] }, "sort": { "in": "query", "name": "sort", "description": "Attributes to sort on\n", "schema": { "type": "string", "enum": [ "event_at", "-event_at" ], "default": "event_at" }, "example": "-event_at" }, "saved_vacancy_id-2": { "in": "path", "name": "saved_vacancy_id", "description": "The ID of the saved vacancy.", "required": true, "schema": { "type": "string" }, "example": "4b5f0698-2d46-4f79-848f-8e4ac467ef4d" }, "vacancy_state_id": { "name": "vacancy_state_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the vacancy state", "example": "fb36242f-fcb1-4a0b-bd46-7f3f621a4f82" }, "track_id": { "name": "track_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the track", "example": "bda75aa5-dc58-4914-8128-ae3e6d075983" }, "filter-6": { "in": "query", "name": "filter[]", "description": "Filters to query specific conversations.\n\nFilter | Type | Description | Example value\n------ | ---- | ----------- | -------------\nhidden | `flag` | Only return hidden (archived) conversations | hidden\n", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "hidden" ] }, "sort-2": { "in": "query", "name": "sort", "description": "attributes to sort on\n", "schema": { "type": "string", "enum": [ "last_event", "-last_event" ], "default": "-last_event" }, "example": "last_event" }, "x_request_id": { "in": "header", "name": "X-Request-Id", "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string", "format": "uuid" }, "example": "2bcef744-8c44-4595-9e1c-55c8a275e140" }, "conversation_id": { "in": "path", "name": "conversation_id", "description": "The ID of a conversation.", "required": true, "schema": { "type": "string", "format": "uuid:uuid" }, "example": "aeeb4ecc-715c-45a2-8240-dfd7e856db74:0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "filter-7": { "in": "query", "name": "filter[]", "description": "Filters to query specific notifications.\n\nFilter | Type | Description | Example value\n------ | ---- | ----------- | -------------\nread | `flag` | Only return notifications that have been read by the user | read\n", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "read" ] }, "sort-3": { "in": "query", "name": "sort", "description": "attributes to sort on\n", "schema": { "type": "string", "enum": [ "created_at", "-created_at" ], "default": "-created_at" }, "example": "created_at" }, "notification_id": { "in": "path", "name": "notification_id", "description": "The ID of an notification.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "filter-8": { "in": "query", "name": "filter[]", "description": "Filters to query specific custom fields.\n\n| Filter | Type | Description | Example value |\n| ------ | ---- | ----------- | ------------- |\n| customizable_type | `string` | Only return custom fields for a specific type of resource. | customizable_type:EmployerVacancy |\n", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "customizable_type:EmployerVacancy" ] } }, "requestBodies": { "body": { "description": "parameters for the action", "content": { "application/json": { "schema": { "type": "object", "required": [ "subject_token", "subject_token_type", "grant_type" ], "properties": { "subject_token": { "description": "A token containing the identity of the user", "type": "string", "example": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjVDRjI2NDY5MjY5MkM5MDBDMzZGNUMxNkU2MEQ1OEFERjI1ODhFNEEifQ.eyJzdWIiOiIxMjkwOTUyMDUiLCJpc3MiOiJodHRwczovL3RtYS5hY2MuYW1zdGVyZGFtLm5sIiwiYXVkIjoic3Z3aSIsImV4cCI6MTY4MTAwNzAxMiwiaWF0IjoxNjgwNzkxMDEyLCJuYmYiOjE2ODA3OTEwMTIsIm5vbmNlIjoiMmZmODQwYjE1MDA5ZDQ4MzhjOTE0MmQ3NWEwYmRmYzQiLCJzaWQiOiI3NENGRUIzODgzMEU5ODNDRTg4QzYyMTZGM0E5MEMxMTRDQjNCRTBCQ0ZFODIyRTUwMkI3RUU2M0M0NDcwQ0Y2QzQxODNBMTg3QzAyRkZDOURBQUVBOUJFN0I4RDAzQTk5QTNGNEY3ODM0NTM2OTc1MDFDQjgzMkRBMzY0RjlERjVENjdFOEQxODM2NTVDOTRBNTczQzFCM0Q0MDE5QzJBNUJEQ0NBREY1MjQ1MEM3N0M2MENBNUFDQUI1QUY1OEE2QURDOUI1RDAwQTUwOEU4NTUzMzg5MTRGRDA5REU1RUMzN0E3QzA4OUVDN0NBQkIiLCJ2ZXIiOiIxLjAiLCJhcHBpZGFjciI6IjAiLCJjX2hhc2giOiJZcE1mSGx2WUFxTU9mcWZvRFV2SFpnIiwidWlkIjoiMTI5MDk1MjA1IiwiYXV0aHNwX2xldmVsIjoiMTAiLCJzZWxfYXV0aHNwIjoiaHR0cHM6Ly93YXMtcHJlcHJvZDEuZGlnaWQubmwvc2FtbC9pZHAvbWV0YWRhdGEiLCJhdXRoc3BfdHlwZSI6InNhbWwyMCIsImNsaWVudF9pcCI6IjgzLjgxLjE5NS43MSIsImxhbmd1YWdlIjoiZW4iLCJzZWxfbGV2ZWwiOiIxMCIsIm5hbWVfaWQiOiJzMDAwMDAwMDA6MTI5MDk1MjA1IiwidXNlcl9hZ2VudCI6Ik1vemlsbGEvNS4wIChNYWNpbnRvc2g7IEludGVsIE1hYyBPUyBYIDEwXzE1XzcpIEFwcGxlV2ViS2l0LzUzNy4zNiAoS0hUTUwsIGxpa2UgR2Vja28pIENocm9tZS8xMTEuMC4wLjAgU2FmYXJpLzUzNy4zNiJ9.bQ5mX6kVgPihsk1AtosubAITgQ0RLL-5XGQU0MA8gA5auAYSNkbX_XlM7zNXx8_kH6J0e7K1VQHnBYFC-OmaAqJi3x_FI1CzlYwLiBglxhiY0si3_Y3d0vTiyg7enruO7Crs8lBza3SXgYiAVbciqWT2bpqV_r5q0_Hhawy8p8e8iLjUJv2-9xsAPwHpCfboi5XNi6AuRJJCd76opBkLKc4msMsM9wTE-yk4XcJva0Yonj_YfNm5miiF7DMKRrwLBpkjS3L2E5JVAGQad5n5Z7ylNXmwASlVJHA5WHeP1gmgHsXaMkyGa4xBVgQSflpnwUKlaJyBnxL6zTWk9goxgA" }, "subject_token_type": { "description": "The type of subject_token that is given.", "type": "string", "enum": [ "urn:ietf:params:oauth:token-type:id_token", "urn:ietf:params:oauth:token-type:access_token" ], "example": "urn:ietf:params:oauth:token-type:id_token" }, "grant_type": { "description": "The type of action requested from this endpoint", "type": "string", "enum": [ "urn:ietf:params:oauth:grant-type:token-exchange" ], "example": "urn:ietf:params:oauth:grant-type:token-exchange" } } } } } } }, "responses": { "ok": { "description": "The response will be a json object with the issued token.\n", "content": { "application/json": { "schema": { "type": "object", "required": [ "access_token", "issued_token_type", "expires_in", "token_type" ], "properties": { "access_token": { "type": "string", "description": "The issued token representing the user", "example": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2NvbnRleHRfaWQiOiIyYjFiNTE1MS03OGY2LTQ3NDctOWMzNy1lMDFhMmVhNDdhNzYiLCJ1c2VyX2lkIjoiMDlhMmZiMGYtMTA4MC00MDVjLTllMmItZWZhOGI2MDg1YWY0IiwiYXBwX2lkIjoiNTVmOTIxZGUtOWUzOC00NjgwLTk5OGItMmYwOWMxYzNmMTM5IiwiZXhwIjoxNjgwODgyMDgyLCJyZXF1ZXN0ZXIiOiJhcHAifQ.uSmC6t6g_2KcLFkvDHl1phnO7qtWr_HYgQMw7QUHCtc" }, "issued_token_type": { "type": "string", "description": "The type of token issued.", "enum": [ "urn:ietf:params:oauth:token-type:jwt" ], "example": "urn:ietf:params:oauth:token-type:jwt" }, "expires_in": { "type": "integer", "description": "The number of seconds the token is issued for.", "example": 3600 }, "token_type": { "type": "string", "enum": [ "Bearer" ], "example": "Bearer", "description": "The way to use this token in a following request" } } } } } }, "bad_request": { "description": "Request is invalid", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error", "required": [ "error" ] }, "example": { "error": "invalid_request", "error_description": "subject_token_type is not supported" } } } }, "unauthorized": { "description": "Unauthorized.", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-2" }, "example": { "message": "Unauthorized: Signature verification failed" } } } }, "forbidden": { "description": "Forbidden.", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/error-2" }, "example": { "message": "forbidden" } } } }, "not_found": { "description": "The resource was not found.", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error", "required": [ "error" ] }, "example": { "error": "invalid_target" } } } }, "server_error": { "description": "Server error.", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "error" ], "properties": { "status": { "type": "integer" }, "error": { "type": "string" } } }, "example": { "status": 500, "error": "Internal Server Error" } } } }, "created": { "description": "The created one-time SSO URL", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/one_time_sso_url" } }, "required": [ "data" ] } } } }, "bad_request-2": { "description": "Request is invalid", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-2" }, "example": { "message": "subject_token_type is not supported" } } } }, "not_found-2": { "description": "The resource was not found.", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-2", "required": [ "message" ] }, "example": { "message": "Resources::ResourceNotFound" } } } }, "ok-2": { "description": "A user context object", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/user_context" }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } } } }, "ok-3": { "description": "The response will be a JSON array of dossier objects for the organization.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/dossier" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data" ] } } } }, "created-2": { "description": "Dossier created.", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/dossier" } }, "required": [ "data" ] } } } }, "unprocessable_content": { "description": "Unprocessable Content.", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/error-2" }, "example": { "message": "Invalid name" } } } }, "ok-4": { "description": "A dossier object", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/dossier" } }, "required": [ "data" ] } } } }, "created-3": { "description": "User context created.", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/user_context" } }, "required": [ "data" ] } } } }, "ok-5": { "description": "The response will be a JSON array of employer vacancy objects for the organization.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/employer_vacancy" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data" ] } } } }, "ok-6": { "description": "An employer vacancy object", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/employer_vacancy" } }, "required": [ "data" ] } } } }, "no_content": { "description": "The action was successful and the response body is empty.", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } } }, "ok-7": { "description": "The response will be a JSON array of contact objects for the organization.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/contact" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data" ] } } } }, "ok-8": { "description": "A contact object", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/contact" } }, "required": [ "data" ] } } } }, "ok-9": { "description": "The response will be a JSON array of employer objects for the organization.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/employer" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data" ] } } } }, "ok-10": { "description": "List of saved vacancies for a dossier.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/saved_vacancy" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "links", "meta", "jsonapi" ] } } } }, "ok-11": { "description": "The requested saved vacancy.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/saved_vacancy" }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "meta", "jsonapi" ] } } } }, "ok-12": { "description": "List of saved vacancy activities for a dossier.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/activity" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "links", "meta", "jsonapi" ] } } } }, "ok-13": { "description": "The requested vacancy states.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/vacancy_state" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "meta", "jsonapi" ] } } } }, "ok-14": { "description": "A vacancy state object", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/vacancy_state" } }, "required": [ "data" ] } } } }, "ok-15": { "description": "The response will be a JSON array of track objects for the organization.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/track" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data" ] } } } }, "ok-16": { "description": "A track object", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/track" } }, "required": [ "data" ] } } } }, "ok-17": { "description": "The response will be a JSON array of conversation objects for the user context.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/conversation" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "links", "meta", "jsonapi" ] } } } }, "ok-18": { "description": "The response will be a conversation object.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "$ref": "#/components/schemas/conversation" }, "meta": { "type": "object", "default": {} }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "meta", "jsonapi" ] } } } }, "ok-19": { "description": "The response will be a JSON array of notification objects for the user context.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/notification" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "links", "meta", "jsonapi" ] } } } }, "ok-20": { "description": "The response will be a notification object.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/notification" }, "meta": { "type": "object", "default": {} }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "meta", "jsonapi" ] } } } }, "ok-21": { "description": "The response will be a JSON array of custom field objects for the organization.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/custom_field" } }, "links": { "allOf": [ { "$ref": "#/components/schemas/links" } ] }, "meta": { "allOf": [ { "$ref": "#/components/schemas/meta" } ] }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data" ] } } } }, "export_dossiers": { "description": "Exported dossier objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/dossier-2" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_profiles": { "description": "Exported profile objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/profile" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_educations": { "description": "Exported education objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/education" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_members": { "description": "Exported member objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/member" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_taxonomy_sectors": { "description": "Exported sector objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/taxonomy_sector" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_taxonomy_occupations": { "description": "Exported occupation objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/taxonomy_occupation" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_contacts": { "description": "Exported contact objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/contact-2" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } } } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_notes": { "description": "Exported note objects.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/note" } }, "jsonapi": { "$ref": "#/components/schemas/jsonapi" } } } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_placements": { "description": "Exported placement objects.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/placement" } }, "jsonapi": { "$ref": "#/components/schemas/jsonapi" } } } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_employer_vacancies": { "description": "Exported employer vacancy objects.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/employer_vacancy-2" } }, "jsonapi": { "$ref": "#/components/schemas/jsonapi" } } } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_employer_vacancy_dossiers": { "description": "Exported employer vacancy dossier objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/employer_vacancy_dossier" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_showrooms": { "description": "Exported showroom objects.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/showroom" } }, "jsonapi": { "$ref": "#/components/schemas/jsonapi" } } } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_employers": { "description": "Exported employer objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/employer-2" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_tasks": { "description": "Exported task objects.\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/task" } }, "jsonapi": { "$ref": "#/components/schemas/jsonapi" } } } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } }, "export_tracks": { "description": "Exported track objects\n", "headers": { "X-Request-Id": { "description": "The ID of the request/response for logging through a chain of requests.\n", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/track-2" } }, "jsonapi": { "allOf": [ { "$ref": "#/components/schemas/jsonapi" } ] } }, "required": [ "data", "jsonapi" ] } }, "text/csv": { "schema": { "type": "string", "description": "A CSV-formatted string containing the exported resource data.\nEach row represents a resource, and columns correspond to the resource's attributes and relationships.\nThe CSV includes the same attributes and relationships as the JSON:API format.\nThe first row contains the column headers.\n\nThe [CSV overview](/csv-overview.html) lists all exported columns per resource type.\n" } } } } }, "schemas": { "error": { "title": "OAuthError", "type": "object", "properties": { "error": { "type": "string", "description": "A message providing additional information about the error, including\ndetails to help resolve it when possible.\n" }, "error_description": { "type": "string", "description": "A human-readable text providing additional information, used to assist\nthe client developer in understanding the error that occurred.\n" } } }, "error-2": { "title": "JobportError", "type": "object", "properties": { "message": { "type": "string", "description": "A message providing additional information about the error, including\ndetails to help resolve it when possible.\n" } } }, "one_time_sso_url": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the one-time SSO URL.", "example": "92cfceb39d57d914ed8b14d0e37643de0797ae56" }, "type": { "type": "string", "enum": [ "one_time_urls" ] }, "attributes": { "type": "object", "description": "One-time SSO URL attributes.", "properties": { "url": { "type": "string", "format": "url", "description": "Short-lived one-time SSO URL.", "example": "https://accounts.jobport.nl/auth/otp/..." } } } }, "required": [ "id", "type", "attributes" ] }, "user_context": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the user context.\n", "example": "932a506c-03f9-4178-b2b4-cdc8e46229c7" }, "type": { "type": "string", "enum": [ "user_contexts" ] }, "attributes": { "type": "object", "description": "A list of attributes of the user context.\n", "properties": { "name": { "type": "string", "description": "The name of the user in this context.\n", "example": "John Doe" }, "image": { "type": "string", "format": "uri", "description": "The URL of the user's avatar image in this context.\n", "example": "https://jobport.example/images/john_doe.jpg" }, "organization_name": { "type": "string", "description": "The name of the organization this user context belongs to.\n", "example": "Big Business BV" }, "role_type": { "type": "string", "description": "The type of role of the user in this context.\n\nRole type | Description\n--------- | -----------\ncontact | A contact person of an employer.\nclient | A candidate associated with a dossier.\nmaintainer | A Jobport employee.\nmember | An employee of the organization, such as a coach.\n", "enum": [ "contact", "client", "maintainer", "member" ], "example": "client" } }, "required": [] } }, "required": [ "id", "type", "attributes" ] }, "jsonapi": { "type": "object", "properties": { "version": { "type": "string", "description": "The jsonapi version number", "default": "1.0" } }, "required": [ "version" ] }, "relationship": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "type": { "type": "string", "example": "type", "description": "The jsonapi type of the resource.\n" }, "id": { "type": "string", "format": "uuid", "example": "d769a21b-b125-42a8-bd41-22debb5c1110", "description": "The ID of the resource. This is automatically generated upon creation.\n" } }, "required": [ "type", "id" ] } } }, "dossier": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of each dossier. This is automatically generated upon creation.", "example": "fd2f1835-3b06-4653-91b4-c4b2ad10f012" }, "type": { "type": "string", "enum": [ "dossiers" ] }, "attributes": { "type": "object", "description": "Dossier attributes.", "properties": { "archive_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time when the dossier is scheduled to be archived.", "example": "2025-06-02T12:00:00Z" }, "archived_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time when the dossier was archived.", "example": "2025-06-01T15:30:00Z" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the dossier was created.", "example": "2025-05-01T09:00:00Z" }, "name": { "type": "string", "description": "The name of the candidate.", "example": "John Doe" }, "send_invitation_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time when an invitation was sent for the dossier.", "example": "2025-06-02T13:00:00Z" }, "user_last_seen_at": { "type": "string", "format": "date-time", "nullable": true, "description": "The last time the user associated with this dossier was seen.", "example": "2025-06-02T14:00:00Z" } } }, "relationships": { "type": "object", "description": "Dossier relationships.", "properties": { "track": { "$ref": "#/components/schemas/relationship" }, "user_context": { "$ref": "#/components/schemas/relationship" } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "The current url requested", "example": "/public/v1/resources/" }, "first": { "type": "string", "description": "The first page of the results", "example": "/public/v1/resources/?page=1&page_size=20" }, "last": { "type": "string", "description": "The first page of the results", "example": "/public/v1/resources/?page=4&page_size=20" } }, "required": [ "self", "first", "last" ] }, "meta": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page request", "default": 1 }, "page_size": { "type": "integer", "description": "The number of items requested for the page", "default": 20 }, "total": { "type": "integer", "description": "The total number of records across all pages" } }, "required": [ "page", "page_size" ] }, "employer_vacancy": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the employer vacancy. This is automatically generated upon creation.", "example": "5f7e87f6-c89c-44de-b9f7-e29860ca90aa" }, "type": { "type": "string", "enum": [ "employer_vacancies" ] }, "attributes": { "type": "object", "description": "Employer vacancy attributes.", "properties": { "contact_through": { "nullable": true, "type": "string", "enum": [ "account_manager", "employer", null ], "description": "Who to get in touch with regarding this vacancy.", "example": "account_manager" }, "title": { "type": "string", "description": "The title of the vacancy.", "example": "Klantgerichte medewerker gezocht voor de klantenservice" }, "postal_code": { "type": "string", "nullable": true, "description": "The postal code where the vacancy is located. Must be a valid Dutch postal code. Letters may be omitted.", "pattern": "^[1-9]\\d{3}(\\s?[a-zA-Z]{2})?$", "example": "5611 AZ" }, "city": { "type": "string", "description": "The city where the vacancy is located.", "example": "Amsterdam" }, "education_level": { "type": "string", "nullable": true, "description": "Education level for the vacancy.", "enum": [ "basic_education", "vmbo", "havo_vwo", "mbo_1", "mbo_2", "mbo_3", "mbo_4", "hbo", "wo_master", null ] }, "hours_per_week_max": { "type": "integer", "nullable": true, "description": "Maximum number of hours per week for the vacancy.", "maximum": 40, "example": 40 }, "hours_per_week_min": { "type": "integer", "nullable": true, "description": "Minimum number of hours per week for the vacancy. Not greater than hours_per_week_max.", "minimum": 0, "example": 32 }, "starts_at": { "type": "string", "format": "date", "description": "When the vacancy has been opened.", "example": "2025-01-01" }, "ends_at": { "type": "string", "format": "date", "description": "When the vacancy closes.", "example": "2025-06-30" }, "description": { "type": "string", "description": "A detailed description of the vacancy. Markdown is supported. HTML input is sanitized (unsupported tags removed) and converted to Markdown.", "example": "We zoeken een enthousiaste _medewerker klantenservice_ die ons team komt versterken." }, "external_url": { "type": "string", "format": "uri", "nullable": true, "description": "External URL where candidates can view and apply for the vacancy.", "example": "https://example.com/vacatures/software-engineer" }, "published": { "type": "boolean", "description": "Indicates whether the vacancy is currently published.", "example": true }, "work_types": { "type": "array", "items": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "description": "RIASEC work types associated with the vacancy.", "example": [ "social", "conventional" ] }, "archived": { "type": "boolean", "description": "Indicates whether the vacancy is archived. Set to false to unarchive the vacancy.", "example": false }, "custom_fields": { "type": "object", "description": "Custom field values for the vacancy. Keys are field codes and values are the corresponding field\nvalues. Value types and restrictions depend on the custom field definition. Custom field definitions\ncan be retrieved using the custom fields endpoint.\n\nThe object will be merged with existing custom fields on updates. If a field is not present in the\nupdate request, it will not be modified.\n", "example": { "pay_grade": 10 } } }, "required": [ "contact_through", "title", "city", "description", "starts_at", "ends_at", "published" ] }, "relationships": { "type": "object", "properties": { "employer": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The employer associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the employer.", "example": "c888a1fd-de7c-430a-8f83-19c6bfa8105b" }, "type": { "type": "string", "enum": [ "employers" ] } } } } }, "contact": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The contact associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact.", "example": "6360dbc8-987b-4b20-8928-ae6f950d8008" }, "type": { "type": "string", "enum": [ "contacts" ] } } } } }, "contact_management": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The manager contact associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact.", "example": "6360dbc8-987b-4b20-8928-ae6f950d8008" }, "type": { "type": "string", "enum": [ "contacts" ] } } } } }, "contact_recruitment": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The recruiter contact associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact.", "example": "6360dbc8-987b-4b20-8928-ae6f950d8008" }, "type": { "type": "string", "enum": [ "contacts" ] } } } } } }, "required": [ "employer" ] } }, "required": [ "id", "type", "attributes" ] }, "type": { "type": "string", "enum": [ "employer_vacancies" ] }, "attributes": { "type": "object", "description": "Employer vacancy attributes.", "properties": { "contact_through": { "nullable": true, "type": "string", "enum": [ "account_manager", "employer", null ], "description": "Who to get in touch with regarding this vacancy.", "example": "account_manager" }, "title": { "type": "string", "description": "The title of the vacancy.", "example": "Klantgerichte medewerker gezocht voor de klantenservice" }, "postal_code": { "type": "string", "nullable": true, "description": "The postal code where the vacancy is located. Must be a valid Dutch postal code. Letters may be omitted.", "pattern": "^[1-9]\\d{3}(\\s?[a-zA-Z]{2})?$", "example": "5611 AZ" }, "city": { "type": "string", "description": "The city where the vacancy is located.", "example": "Amsterdam" }, "education_level": { "type": "string", "nullable": true, "description": "Education level for the vacancy.", "enum": [ "basic_education", "vmbo", "havo_vwo", "mbo_1", "mbo_2", "mbo_3", "mbo_4", "hbo", "wo_master", null ] }, "hours_per_week_max": { "type": "integer", "nullable": true, "description": "Maximum number of hours per week for the vacancy.", "maximum": 40, "example": 40 }, "hours_per_week_min": { "type": "integer", "nullable": true, "description": "Minimum number of hours per week for the vacancy. Not greater than hours_per_week_max.", "minimum": 0, "example": 32 }, "starts_at": { "type": "string", "format": "date", "description": "When the vacancy has been opened.", "example": "2025-01-01" }, "ends_at": { "type": "string", "format": "date", "description": "When the vacancy closes.", "example": "2025-06-30" }, "description": { "type": "string", "description": "A detailed description of the vacancy. Markdown is supported. HTML input is sanitized (unsupported tags removed) and converted to Markdown.", "example": "We zoeken een enthousiaste _medewerker klantenservice_ die ons team komt versterken." }, "external_url": { "type": "string", "format": "uri", "nullable": true, "description": "External URL where candidates can view and apply for the vacancy.", "example": "https://example.com/vacatures/software-engineer" }, "published": { "type": "boolean", "description": "Indicates whether the vacancy is currently published.", "example": true }, "work_types": { "type": "array", "items": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "description": "RIASEC work types associated with the vacancy.", "example": [ "social", "conventional" ] }, "archived": { "type": "boolean", "description": "Indicates whether the vacancy is archived. Set to false to unarchive the vacancy.", "example": false }, "custom_fields": { "type": "object", "description": "Custom field values for the vacancy. Keys are field codes and values are the corresponding field\nvalues. Value types and restrictions depend on the custom field definition. Custom field definitions\ncan be retrieved using the custom fields endpoint.\n\nThe object will be merged with existing custom fields on updates. If a field is not present in the\nupdate request, it will not be modified.\n", "example": { "pay_grade": 10 } } }, "required": [ "contact_through", "title", "city", "description", "starts_at", "ends_at", "published" ] }, "relationships": { "type": "object", "properties": { "employer": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The employer associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the employer.", "example": "c888a1fd-de7c-430a-8f83-19c6bfa8105b" }, "type": { "type": "string", "enum": [ "employers" ] } } } } }, "contact": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The contact associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact.", "example": "6360dbc8-987b-4b20-8928-ae6f950d8008" }, "type": { "type": "string", "enum": [ "contacts" ] } } } } }, "contact_management": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The manager contact associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact.", "example": "6360dbc8-987b-4b20-8928-ae6f950d8008" }, "type": { "type": "string", "enum": [ "contacts" ] } } } } }, "contact_recruitment": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The recruiter contact associated with the vacancy.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact.", "example": "6360dbc8-987b-4b20-8928-ae6f950d8008" }, "type": { "type": "string", "enum": [ "contacts" ] } } } } } }, "required": [ "employer" ] }, "contact": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the contact. This is automatically generated upon creation.", "example": "db94b3d8-6441-4b30-8643-370ecb96b23d" }, "type": { "type": "string", "enum": [ "contacts" ] }, "attributes": { "type": "object", "description": "Contact attributes.", "properties": { "email": { "type": "string", "format": "email", "nullable": true, "description": "The contact's correspondence email address.", "example": "jane.doe@example.com" }, "name": { "type": "string", "description": "The full name of the contact.", "example": "Jane Doe" }, "notes": { "type": "string", "nullable": true, "description": "Additional notes about the contact.", "example": "Prefers to be contacted by email." }, "phone_number": { "type": "string", "nullable": true, "description": "The contact's phone number. Must be 7 to 15 digits. May include spaces, dashes, and dots as separators, parentheses for grouping (must be closed and not nested), and a leading plus sign.", "example": "+31 (0) 6 1234 5678" }, "archived": { "type": "boolean", "description": "Whether the contact is archived. Set to false to unarchive the contact.", "example": false } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "employer": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The employer associated with the contact.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the employer.", "example": "c888a1fd-de7c-430a-8f83-19c6bfa8105b" }, "type": { "type": "string", "enum": [ "employers" ] } } } } } }, "required": [ "employer" ] } }, "required": [ "id", "type", "attributes" ] }, "type-2": { "type": "string", "enum": [ "contacts" ] }, "attributes-2": { "type": "object", "description": "Contact attributes.", "properties": { "email": { "type": "string", "format": "email", "nullable": true, "description": "The contact's correspondence email address.", "example": "jane.doe@example.com" }, "name": { "type": "string", "description": "The full name of the contact.", "example": "Jane Doe" }, "notes": { "type": "string", "nullable": true, "description": "Additional notes about the contact.", "example": "Prefers to be contacted by email." }, "phone_number": { "type": "string", "nullable": true, "description": "The contact's phone number. Must be 7 to 15 digits. May include spaces, dashes, and dots as separators, parentheses for grouping (must be closed and not nested), and a leading plus sign.", "example": "+31 (0) 6 1234 5678" }, "archived": { "type": "boolean", "description": "Whether the contact is archived. Set to false to unarchive the contact.", "example": false } }, "required": [ "name" ] }, "relationships-2": { "type": "object", "properties": { "employer": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "The employer associated with the contact.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the employer.", "example": "c888a1fd-de7c-430a-8f83-19c6bfa8105b" }, "type": { "type": "string", "enum": [ "employers" ] } } } } } }, "required": [ "employer" ] }, "employer": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier for the employer.", "example": "e5d5c188-cbe2-4d49-8e9e-5523c3d384c6" }, "type": { "type": "string", "enum": [ "employers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the employer.", "example": "Jobport" }, "description": { "type": "string", "nullable": true, "description": "Description of the employer.", "example": "Jobport is an Information Technology & Services company that specializes in developing and providing employability software." }, "street": { "type": "string", "nullable": true, "description": "Street name of the employer's address.", "example": "Emmasingel" }, "house_number": { "type": "string", "nullable": true, "description": "House number of the employer's address.", "example": "33" }, "postal_code": { "type": "string", "nullable": true, "description": "Dutch postal code of the employer's address.", "pattern": "^[1-9]\\d{3}\\s?[a-zA-Z]{2}$", "example": "5611 AZ" }, "city": { "type": "string", "nullable": true, "description": "City where the employer is located.", "example": "Eindhoven" }, "country_code": { "type": "string", "nullable": true, "description": "Country code (ISO 3166-1 alpha-2).", "example": "NL" }, "website_url": { "type": "string", "format": "uri", "nullable": true, "description": "Employer's website URL.", "example": "https://www.jobport.nl" }, "legal_form": { "type": "string", "nullable": true, "description": "Legal form of the employer.", "example": "BV" }, "national_id": { "type": "string", "nullable": true, "description": "National identifier (KVK number) for the employer.", "example": "12345678" }, "national_branch_id": { "type": "string", "nullable": true, "description": "National branch identifier (KVK branch number).", "example": "123456789012" }, "archived": { "type": "boolean", "description": "Whether the employer is archived. Set to false to unarchive the employer.", "example": false }, "custom_fields": { "type": "object", "description": "Custom field values for the vacancy. Keys are field codes and values are the corresponding field\nvalues. Value types and restrictions depend on the custom field definition. Custom field definitions\ncan be retrieved using the custom fields endpoint.\n" } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "primary_account_manager": { "type": "object", "description": "The member that is the primary account manager for the employer.", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the member.", "example": "08cc1ece-8756-4028-a4f8-92383cef1bc5" }, "type": { "type": "string", "enum": [ "members" ] } } } } } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "saved_vacancy": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of each saved vacancy. This is automatically generated upon creation.\n", "example": "309f3433-fdee-40c5-8aff-b243f06939da" }, "type": { "type": "string", "enum": [ "saved_vacancies" ] }, "attributes": { "type": "object", "description": "A list of attributes of the saved vacancy.\n", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the saved vacancy was created.\n", "example": "2024-12-19T20:49:23+02:00" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the saved vacancy was last updated.\n", "example": "2024-12-19T21:49:23+02:00" } } }, "relationships": { "type": "object", "description": "Saved vacancy relationships.\n", "properties": { "dossier": { "$ref": "#/components/schemas/relationship" }, "vacancy": { "$ref": "#/components/schemas/relationship" }, "vacancy_state": { "$ref": "#/components/schemas/relationship" } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "activity": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the activity. This is automatically generated upon creation.\n", "example": "e69a80d6-a3a2-4bff-8ffd-486bd6edb62b" }, "type": { "type": "string", "enum": [ "saved_vacancy_activities" ] }, "attributes": { "type": "object", "description": "A list of attributes of the activity\n", "properties": { "event_at": { "type": "string", "format": "date-time", "description": "Date and time when the activity occurred.\n", "example": "2024-12-19T20:49:23+02:00" }, "from_state": { "type": "string", "nullable": true, "description": "ID of the state of the vacancy before the activity occurred.\n", "example": "e8583a2a-2f13-4fbb-be05-b1a4b231379e" }, "to_state": { "type": "string", "description": "ID of the state of the vacancy after the activity occurred.\n", "example": "b1a4b231-379e-e858-2f13-4fbb-be05-b1a4" } } }, "relationships": { "type": "object", "description": "Saved vacancy relationships.\n", "properties": { "saved_vacancy": { "$ref": "#/components/schemas/relationship" } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "vacancy_state": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the vacancy state.\n", "example": "300cc338-d74c-4b20-aea7-522c8c3e64fb" }, "type": { "type": "string", "enum": [ "vacancy_states" ] }, "attributes": { "type": "object", "description": "A list of attributes for the vacancy state\n", "properties": { "code": { "type": "string", "example": "applied", "description": "A code representing the vacancy state.\n" }, "label": { "type": "string", "example": "Gesolliciteerd", "description": "A short text representing the vacancy state in Dutch.\n" }, "description": { "type": "string", "example": "Gesolliciteerd", "description": "A possibly longer description of the vacancy state in Dutch.\n" } } } }, "required": [ "id", "type", "attributes" ] }, "track": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of each track. This is automatically generated upon creation.", "example": "fd2f1835-3b06-4653-91b4-c4b2ad10f012" }, "type": { "type": "string", "enum": [ "tracks" ] }, "attributes": { "type": "object", "description": "Track attributes.", "properties": { "name": { "type": "string", "description": "The name of the track.", "example": "Traject met Jobport toegang" }, "description": { "type": "string", "nullable": true, "description": "A description of the track.", "example": "Traject waarbij de kandidaat toegang krijgt" } } } }, "required": [ "id", "type", "attributes" ] }, "conversation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid:uuid", "description": "The ID of each conversation. This is automatically generated upon creation.\nThe value is a combination of the user_context_id and thread_id seperated by `:`\n", "example": "aeeb4ecc-715c-45a2-8240-dfd7e856db74:0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "type": { "type": "string", "enum": [ "conversations" ] }, "attributes": { "type": "object", "description": "A list of attributes of the converstation.\n", "properties": { "subject": { "type": "string", "description": "subject of the converstation\n", "example": "Voortgang sollicitatie" }, "participant_names": { "type": "array", "items": { "type": "string" }, "description": "All the names of the other participants in this conversation\n", "example": [ "Cornelis Coach" ] }, "last_event_at": { "type": "string", "format": "date-time", "description": "Time of the last event in the conversation (a message or someone leaving/joining).\n", "example": "2023-12-19T20:49:23+02:00" }, "is_read": { "type": "boolean", "description": "A boolean indicating if the conversation has unread messages.\n" } }, "required": [ "subject", "participant_names", "last_event_at", "is_read" ] }, "links": { "type": "object", "description": "A list of links related to the conversation\n", "properties": { "canonical": { "type": "string", "nullable": true, "description": "A http link which can be used to open the link in the Jobport application\n", "example": "https://app.jobport.nl/deeplinks/some-identifier" } }, "required": [ "canonical" ] } }, "required": [ "id", "type", "attributes" ] }, "notification": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of each notification. This is automatically generated upon creation.\n", "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "type": { "type": "string", "enum": [ "notifications" ] }, "attributes": { "type": "object", "description": "A list of attributes of the notification.\n", "properties": { "title": { "type": "string", "description": "A brief explaination of the notification.\n", "example": "Download staat klaar" }, "is_read": { "type": "boolean", "description": "A boolean indicating if the notification is read.\n" }, "created_at": { "type": "string", "format": "date-time", "description": "Time of the notification's creation.\n", "example": "2023-12-19T20:49:23+02:00" }, "updated_at": { "type": "string", "format": "date-time", "description": "Time of the notification's last update.\n", "example": "2023-12-19T20:49:23+02:00" } }, "required": [ "title", "is_read", "created_at", "updated_at" ] }, "links": { "type": "object", "description": "A list of links related to the notification\n", "properties": { "canonical": { "type": "string", "nullable": true, "description": "A http link which can be used to open the link in the Jobport application\n", "example": "https://app.jobport.nl/deeplinks/some-identifier" } }, "required": [ "canonical" ] } }, "required": [ "id", "type", "attributes", "links" ] }, "string": { "type": "object", "properties": { "minimum_characters": { "type": "integer", "description": "Minimum length of the string.", "example": 1 }, "maximum_characters": { "type": "integer", "description": "Maximum length of the string.", "example": 255 } }, "required": [ "minimum_characters" ] }, "date": { "type": "object", "properties": { "required": { "type": "boolean", "description": "Indicates if a value is required for this field.", "example": true } }, "required": [ "required" ] }, "number": { "type": "object", "properties": { "required": { "type": "boolean", "description": "Indicates if a value is required for this field.", "example": true }, "minimum": { "type": "number", "description": "Minimum value for the number.", "example": 0 }, "maximum": { "type": "number", "description": "Maximum value for the number.", "example": 100 }, "precision": { "type": "integer", "description": "Number of decimal places for the number.", "example": 2 } }, "required": [ "required" ] }, "select": { "type": "object", "properties": { "options": { "type": "array", "description": "List of options available for selection.", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Unique identifier for the option.", "example": "8f24bf9b-28fc-4db3-9922-c835d2fc047f" }, "label": { "type": "string", "description": "Human-readable label for the option.", "example": "Schaal 10" } }, "required": [ "code", "label" ] } }, "minimum_selected": { "type": "integer", "description": "Minimum number of options that must be selected.", "example": 1 }, "maximum_selected": { "type": "integer", "description": "Maximum number of options that can be selected.", "example": 3 } }, "required": [ "options", "minimum_selected", "maximum_selected" ] }, "custom_field": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of each custom field. This is automatically generated upon creation.", "example": "423af44c-dff5-43a3-840d-07bc96762322" }, "type": { "type": "string", "enum": [ "custom_fields" ] }, "attributes": { "type": "object", "description": "Custom field attributes.", "properties": { "code": { "type": "string", "description": "The unique code for the custom field.", "example": "pay_grade" }, "label": { "type": "string", "description": "Human-readable label for the custom field.", "example": "Salarisschaal" }, "type": { "type": "string", "description": "The type of the custom field.", "enum": [ "string", "date", "number", "select" ], "example": "select" }, "customizable_types": { "type": "array", "description": "The types of resource that can be customized with this field.", "items": { "type": "string" }, "example": [ "EmployerVacancy" ] }, "default_value": { "description": "Default value for the custom field, if applicable. Type depends on the field type.", "example": "Onbekend" }, "settings": { "description": "Settings for the custom field, which depend on the field's type.", "anyOf": [ { "$ref": "#/components/schemas/string" }, { "$ref": "#/components/schemas/date" }, { "$ref": "#/components/schemas/number" }, { "$ref": "#/components/schemas/select" } ] } } } } }, "dossier-2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the dossier. This is automatically generated upon creation.\n", "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "type": { "type": "string", "default": "dossiers" }, "attributes": { "type": "object", "description": "A list of attributes for the dossier.\n", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Time of the dossier's creation.\n", "example": "2023-12-19T20:49:23+02:00" }, "archived_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when the dossier was archived.\n", "example": "2023-12-19T20:49:23+02:00" }, "candidate_access": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "revoked", "active", "none", "invited", "invitation_expired" ], "example": "none" }, "status_changed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when the access status was changed at.\n", "example": "2023-12-19T20:49:23Z" }, "granted_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when access was granted.\n", "example": "2023-12-19T20:49:23Z" }, "revoked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when access was revoked.\n", "example": "2023-12-20T10:15:00Z" }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when the candidate was last active.\n", "example": "2023-12-21T08:30:00Z" }, "delete_scheduled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when the dossier is scheduled for automatic deletion.\n", "example": "2031-12-22T12:00:00Z" } } }, "administration_number": { "type": "string", "nullable": true, "example": "123456787", "description": "The administration number of the dossier. E.g., a SSN/BSN.\n" }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "doelgroep", "description": "The ID of the custom field.\n" }, "values": { "type": "array", "items": { "type": "string", "example": "bbl" }, "description": "The values given to the custom field.\n" } }, "required": [ "id", "values" ] } }, "direct_contact": { "type": "boolean", "description": "Indicates whether contacts/employers can directly contact the candidate.", "example": false } }, "required": [ "created_at", "archived_at", "candidate_access", "administration_number", "custom_fields", "direct_contact" ] }, "relationships": { "type": "object", "properties": { "track": { "type": "object", "description": "The track identifier the dossier is associated with.\n", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } }, "profile": { "type": "object", "description": "The profile identifier the dossier is associated with.\n", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } }, "showrooms": { "type": "object", "description": "A list of showroom identifiers the dossier is associated with.\n", "properties": { "data": { "type": "array", "items": [ { "$ref": "#/components/schemas/relationship" } ] } } }, "coaches": { "type": "object", "description": "A list of coach identifiers the dossier is associated with. References members.\n", "properties": { "data": { "type": "array", "items": [ { "$ref": "#/components/schemas/relationship" } ] } } }, "primary_coach": { "type": "object", "description": "The primary coach identifier for the dossier. References a member.\n", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "profile": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the profile. This is automatically generated upon creation.\n", "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "type": { "type": "string", "default": "profiles" }, "attributes": { "type": "object", "description": "A list of attributes for the profile.\n", "properties": { "postal_code": { "type": "string", "description": "pattern: /^[1-9]\\d{3}(\\s?[a-zA-Z]{2})?$/\n", "minLength": 4, "maxLength": 7, "nullable": true, "example": "9161AE" }, "education_level_soft": { "type": "string", "nullable": true, "enum": [ "basic_education", "havo_vwo", "hbo_bachelor", "mbo_1", "mbo_2", "mbo_3", "mbo_4", "vmbo", "wo_master", null ], "example": "mbo_4", "description": "The soft education level of the Profile.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
CodeDescription
basic_educationbasisonderwijs
havo_vwohavo/vwo
hbo_bachelorhbo
mbo_1mbo 1
mbo_2mbo 2
mbo_3mbo 3
mbo_4mbo 4
vmbovmbo
wo_masterwo
\n" }, "publish_profile": { "type": "boolean", "example": false, "description": "A boolean indicating if the profile is published.\n" }, "completed_percentage": { "type": "integer", "example": 95, "description": "The completion percentage of the profile.\n" }, "interests": { "type": "array", "items": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "example": [ "artistic", "investigative" ], "description": "A list of RIASEC interests for this profile.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
CodeDescription
realisticDoen en aanpakken (R)
investigativeDenken en onderzoeken (I)
artisticOntwerpen en creatief zijn (A)
socialHelpen, verzorgen en onderwijzen (S)
enterprisingBeslissen en organiseren (O)
conventionalNauwkeurig werken en ordenen (C)
\n" }, "certificates": { "type": "array", "items": { "type": "string", "enum": [ "bhv", "code_95", "ept", "haccp", "heftruck", "medicatie", "reachtruck", "taxipas", "vca_basis", "vca_vol", "veilig_werken_langs_de_weg", "wft" ] }, "example": [ "bhv", "taxipas", "heftruck" ], "description": "A list of certificates for this profile.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
CodeDescription
bhvBHV
code_95Code 95
eptEPT
haccpHACCP/Sociale hygiëne
heftruckHeftruck
medicatieMedicatie
reachtruckReachtruck
taxipasTaxipas
vca_basisVCA Basis
vca_volVCA Vol
veilig_werken_langs_de_wegVeilig werken langs de weg
wftWFT
\n" }, "driving_licenses": { "type": "array", "items": { "type": "string", "enum": [ "am", "a", "a1", "a2", "b", "b1", "b78", "be", "c", "ce", "c1", "c1e", "d", "de", "d1", "d1e", "t" ] }, "example": [ "a", "b" ], "description": "A list of driving licenses for this profile.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
CodeDescription
amAM: rijbewijs voor bromfiets, scooter, speed-pedelec, snorfiets en brommobiel
aA: motorrijbewijs
a1A1: motorrijbewijs
a2A2: motorrijbewijs
bB: autorijbewijs
bcode78B (code78): autorijbewijs (alleen automaat)
bplusB+ (code96) rijbewijs voor auto (B) met aanhanger
beBE: rijbewijs voor auto (B) met aanhanger
cC: vrachtwagenrijbewijs
ceCE: rijbewijs voor vrachtwagen (C) met aanhanger
c1C1: rijbewijs voor 'lichte' vrachtwagen
c1eC1E: rijbewijs voor vrachtwagen (C1) met aanhanger
dD: busrijbewijs
deDE: rijbewijs voor bus (D) met aanhanger
d1D1: rijbewijs voor 'kleine' bus
d1eD1E: rijbewijs voor 'kleine' bus (D1E) met aanhanger
gG: rijbewijs voor landbouwvoertuigen
tT: trekkerrijbewijs
\n" }, "skills": { "type": "array", "items": { "type": "string" }, "example": [ "monitoring", "installation", "active_learning", "learning_strategies", "operation_monitoring" ], "description": "A list of skills for this profile.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
CodeDescription
active_learningNieuwe dingen leren
complex_problem_solvingProblemen oplossen
coordinationJezelf aanpassen aan anderen
critical_thinkingLogisch nadenken
equipment_maintenanceApparatuur onderhouden
equipment_selectionBepalen welk gereedschap of materiaal er nodig is voor een klus
installationTechnische apparatuur installeren
instructingDingen uitleggen
judgment_and_decision_makingBesluiten nemen
learning_strategiesLeren door te doen
management_of_financial_resourcesFinanciën beheren
management_of_material_resourcesWerkuitvoering van anderen managen
management_of_personnel_resourcesPersoneel managen (HRM)
mathematicsDingen uitrekenen
monitoringDingen bijsturen
negotiationOnderhandelen
operation_and_controlApparatuur bedienen
operation_monitoringZorgen dat apparatuur goed werkt
operations_analysisKlantbehoeften vertalen naar producten of diensten
persuasionAnderen overtuigen
programmingProgrammeren
quality_control_analysisProducten of processen inspecteren en testen
repairingDingen repareren
scienceWetenschappelijk denken
service_orientationAnderen helpen
social_perceptivenessAnderen begrijpen
systems_analysisProcessen analyseren
systems_evaluationProcessen verbeteren
technology_designTechnische oplossingen ontwerpen
time_managementTijd managen
troubleshootingTechnische problemen oplossen
\n" }, "favorite_occupations": { "type": "array", "items": { "type": "string", "description": "Codes for favorite occupations" }, "example": [ "onet:29-1122" ], "description": "A list of Taxonomy Occupation codes that are marked as favorite for this profile.\n" }, "favorite_sectors": { "type": "array", "items": { "type": "string", "description": "Codes for favorite sectors" }, "example": [ "jobfeed:profession_class:4", "jobfeed:profession_class:23", "jobfeed:profession_class:3", "jobfeed:profession_class:9", "jobfeed:profession_class:17", "jobfeed:profession_class:14" ], "description": "A list of Taxonomy Sector codes that are marked as favorite for this profile.\n" } }, "required": [ "postal_code", "publish_profile", "completed_percentage", "interests", "certificates", "driving_licenses", "skills", "favorite_occupations", "favorite_sectors" ] }, "relationships": { "type": "object", "properties": { "educations": { "type": "object", "description": "A list of education identifiers the profile is associated with.\n", "properties": { "data": { "type": "array", "items": [ { "$ref": "#/components/schemas/relationship" } ] } } } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "education": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the education. This is automatically generated upon creation.\n", "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "type": { "type": "string", "default": "educations" }, "attributes": { "type": "object", "description": "A list of attributes for the education.\n", "properties": { "abroad": { "type": "boolean", "example": false, "description": "A boolean indicating if the education took place abroad.\n" }, "current": { "type": "boolean", "example": false, "description": "A boolean indicating if the education is currently being followed.\n" }, "description": { "type": "string", "example": "This is a description", "description": "A description of the education.\n" }, "end_date": { "type": "string", "example": "2021", "description": "The date the education ended.\n" }, "graduated": { "type": "boolean", "example": false, "description": "A boolean indicating if the user has graduated from the education.\n" }, "level": { "type": "string", "example": "mbo_4", "description": "The level of the education.\n" }, "location": { "type": "string", "example": "Eindhoven", "description": "The location where the education took place.\n" }, "organization": { "type": "string", "example": "NTI", "description": "The organization that provided the education.\n" }, "start_date": { "type": "string", "example": "2019", "description": "The date the education started.\n" }, "title": { "type": "string", "example": "MBO Business Administration & Control Specialist", "description": "The title of the education.\n" }, "created_at": { "type": "string", "format": "date-time", "description": "Time of the education's creation.\n", "example": "2023-12-19T20:49:23+02:00" } }, "required": [ "abroad", "current", "description", "end_date", "graduated", "level", "location", "organization", "start_date", "title", "created_at" ] }, "relationships": { "type": "object", "properties": { "profile": { "type": "object", "description": "The profile identifier the education is associated with.\n", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "member": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the member. This is automatically generated upon creation.\n", "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "type": { "type": "string", "default": "members" }, "attributes": { "type": "object", "description": "A list of attributes for the member.\n", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Time of the member's creation.\n", "example": "2023-12-19T20:49:23+02:00" }, "archived_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when the member was archived.\n", "example": "2023-12-19T20:49:23+02:00" }, "name": { "type": "string", "example": "John Doe", "description": "The name of the member" }, "email": { "type": "string", "format": "email", "example": "johndoe@example.com", "description": "The email address of the member." }, "administration_number": { "type": "string", "example": "A12345", "description": "The administration number of the member." }, "access": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "revoked" ], "example": "active", "description": "The access status of the **member**." }, "granted_at": { "type": "string", "format": "date-time", "example": "2023-12-19T20:49:23+02:00", "description": "When access was granted." }, "revoked_at": { "type": "string", "format": "date-time", "nullable": true, "example": null, "description": "When access was revoked, if applicable." }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-10T15:00:00+02:00", "description": "Last activity timestamp for the member." } } }, "roles": { "type": "object", "properties": { "account_manager": { "type": "boolean", "example": true, "description": "Whether the member is an account manager." }, "administrator": { "type": "boolean", "example": false, "description": "Whether the member is an administrator." }, "coach": { "type": "boolean", "example": true, "description": "Whether the member is a coach." } } } }, "required": [ "name", "email", "administration_number", "access", "roles" ] } }, "required": [ "id", "type", "attributes" ] }, "taxonomy_sector": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the Taxonomy sector. This is automatically generated upon creation.\n", "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "type": { "type": "string", "default": "taxonomy_sectors" }, "attributes": { "type": "object", "description": "A list of attributes for the Taxonomy sector.\n", "properties": { "name": { "type": "string", "example": "Natuur- en milieuwetenschappen", "description": "The name of the Taxonomy Sector.\n" }, "code": { "type": "string", "example": "jobfeed:profession_class:13", "description": "The jobfeed code of the Taxonomy Sector.\n" }, "published": { "type": "boolean", "example": true, "description": "Whether the Taxonomy Sector is published or not.\n" } }, "required": [ "name", "code", "published" ] } }, "required": [ "id", "type", "attributes" ] }, "taxonomy_occupation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the Taxonomy occupation. This is automatically generated upon creation.\n", "example": "0df21c85-54f5-4ce9-be17-4a2fb63e958c" }, "type": { "type": "string", "default": "taxonomy_occupations" }, "attributes": { "type": "object", "description": "A list of attributes for the Taxonomy occupation.\n", "properties": { "code": { "type": "string", "example": "onet:27-3041", "description": "A code representing the Taxonomy Occupation.\n" }, "name": { "type": "string", "example": "Redacteur", "description": "The Dutch translation of the Taxonomy Occupation's label.\n" }, "published": { "type": "boolean", "example": true, "description": "Whether the Taxonomy Occupation is published or not.\n" } }, "required": [ "code", "name", "published" ] } }, "required": [ "id", "type", "attributes" ] }, "contact-2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the contact.", "example": "c1a2b3d4-5678-90ab-cdef-1234567890ab" }, "type": { "type": "string", "default": "contacts" }, "attributes": { "type": "object", "description": "Contact attributes.", "properties": { "name": { "type": "string", "description": "The contact's name.", "example": "Jane Doe" }, "email": { "type": "string", "format": "email", "description": "The contact's email address.", "example": "jane.doe@example.com" }, "phone_number": { "type": "string", "nullable": true, "description": "The contact's phone number.", "example": "+31 6 12345678" }, "access": { "type": "object", "description": "Access information for the contact.", "properties": { "status": { "type": "string", "description": "Access status.", "enum": [ "active", "invited", "invitation_expired", "revoked", "none" ], "example": "active" }, "granted_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When access was granted.", "example": "2025-06-16T10:00:00+02:00" }, "revoked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When access was revoked.", "example": null }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Last activity timestamp.", "example": "2025-06-16T12:00:00+02:00" } } }, "created_at": { "type": "string", "format": "date-time", "description": "When the contact was created.", "example": "2025-06-01T09:00:00+02:00" }, "archived_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the contact was archived.", "example": null }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the contact was deleted.", "example": null } } }, "relationships": { "type": "object", "description": "Contact relationships.", "properties": { "employer": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "note": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the note.", "example": "be811f91-21fb-4ea6-ac9f-ab4731b80331" }, "type": { "type": "string", "default": "notes" }, "attributes": { "type": "object", "description": "Note attributes.", "properties": { "category_name": { "type": "string", "enum": [ "online_meeting", "onsite_meeting", "phone_call", "other" ], "description": "The internal category name of the note.", "example": "online_meeting" }, "human_category_name": { "type": "string", "description": "The human-readable category name of the note.", "example": "Afspraak (digitaal)" }, "human_subject_type": { "type": "string", "description": "The human-readable type of the note's subject.", "example": "Kandidaat" }, "text": { "type": "string", "description": "The content of the note.", "example": "Kandidaat gesproken over zus en zo. Gemaakte afspraken: dit en dat." }, "title": { "type": "string", "description": "The title of the note.", "example": "Kandidaat gesproken" }, "created_at": { "type": "string", "format": "date-time", "description": "When the note was created.", "example": "2025-06-01T09:00:00+02:00" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the note was last updated.", "example": "2025-06-16T10:00:00+02:00" } } }, "relationships": { "type": "object", "description": "Note relationships.", "properties": { "author": { "type": "object", "description": "Identifier of the author of the note. References a member.", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } }, "subject": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "placement": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the placement.", "example": "db979a41-bfb6-4a42-8f04-53d1efeff360" }, "type": { "type": "string", "default": "placements" }, "attributes": { "type": "object", "description": "Placement attributes.", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "When the placement was created.", "example": "2025-06-01T09:00:00+02:00" }, "custom_fields": { "type": "array", "description": "Custom field values for the placement.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The code of the custom placement field.", "example": "industry_type" }, "values": { "type": "array", "description": "Values for the custom placement field.", "items": { "type": "string" }, "example": [ "IT", "Consulting" ] } } } }, "ends_at": { "type": "string", "format": "date", "nullable": true, "description": "When the placement ends / ended, if applicable.", "example": "2026-04-12" }, "hours_weekly": { "type": "number", "description": "Number of hours per week for the placement.", "example": 36 }, "starts_at": { "type": "string", "format": "date", "description": "When the placement starts / started.", "example": "2025-02-05" }, "vacancy_type": { "type": "string", "description": "The type of vacancy for the placement.", "enum": [ "employer_vacancy", "other", "external_vacancy" ], "example": "employer_vacancy" }, "current": { "type": "boolean", "description": "Whether the placement is currently active.", "example": true } } }, "relationships": { "type": "object", "description": "Placement relationships.", "properties": { "created_by": { "type": "object", "description": "References the member that created the placement.", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" }, "dossier": { "type": "object", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" }, "employer": { "type": "object", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" }, "employer_vacancy": { "type": "object", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "employer_vacancy-2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the employer vacancy.", "example": "55db91b5-c324-499c-973f-d959bfccf579" }, "type": { "type": "string", "enum": [ "employer_vacancies" ] }, "attributes": { "type": "object", "description": "Employer vacancy attributes.", "properties": { "contact_options": { "type": "object", "description": "Contact options for the vacancy.", "properties": { "via_employer": { "type": "boolean", "description": "True if the employer is the contact for the vacancy; false if the account manager is.", "example": true } } }, "created_by_contact": { "type": "boolean", "description": "True if an employer's contact created the vacancy; false if the account manager did.", "example": true }, "custom_fields": { "type": "array", "description": "Custom field values for the vacancy.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Custom field code.", "example": "field_code" }, "values": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Values for the custom field.", "example": [ "value1", "value2" ] } } } }, "description": { "type": "string", "description": "The description of the vacancy.", "example": "Responsible for developing and maintaining software applications." }, "external_url": { "type": "string", "format": "uri", "nullable": true, "description": "External URL where candidates can view and apply for the vacancy.", "example": "https://example.com/vacatures/software-engineer" }, "education_level": { "type": "object", "description": "Education level for the vacancy.", "properties": { "code": { "type": "string", "enum": [ "basic_education", "vmbo", "havo_vwo", "mbo_1", "mbo_2", "mbo_3", "mbo_4", "hbo_bachelor", "wo_master" ], "description": "Education level code.", "example": "basic_education" }, "label": { "type": "string", "description": "Human-readable education level.", "example": "basisonderwijs" } } }, "ends_at": { "type": "string", "format": "date", "nullable": true, "description": "When the vacancy ends, if applicable.", "example": "2025-06-30" }, "hours_per_week": { "type": "object", "description": "Weekly hours for the vacancy.", "properties": { "label": { "type": "string", "description": "Human-readable hours indication.", "example": "32 - 40 uur/week" }, "min": { "type": "integer", "description": "Minimum hours per week.", "example": 32 }, "max": { "type": "integer", "description": "Maximum hours per week.", "example": 40 } } }, "location": { "type": "object", "description": "Location details for the vacancy.", "properties": { "city": { "type": "string", "description": "City of the vacancy location.", "example": "Eindhoven" }, "postal_code": { "type": "string", "nullable": true, "description": "Postal code of the vacancy location. Might exclude trailing letters.", "example": "5611" }, "lat": { "type": "number", "format": "float", "description": "Latitude.", "example": 51.438862 }, "lon": { "type": "number", "format": "float", "description": "Longitude.", "example": 5.475078 } } }, "profession": { "type": "object", "description": "Profession details for the vacancy.", "properties": { "label": { "type": "string", "description": "Human-readable job title.", "example": "Software Engineer" }, "jobfeed_code": { "type": "integer", "description": "Jobfeed profession code.", "example": 12345 } } }, "starts_at": { "type": "string", "format": "date", "description": "When the vacancy starts.", "example": "2025-06-25" }, "title": { "type": "string", "description": "The title of the vacancy.", "example": "Software Engineer" }, "published": { "type": "boolean", "description": "Whether the vacancy is published.", "example": true }, "work_types": { "type": "array", "description": "Array of work type codes (interests).", "items": { "type": "string" }, "example": [ "technical", "administrative" ] }, "work_styles": { "type": "array", "description": "Array of work style codes.", "items": { "type": "string" }, "example": [ "independent", "teamwork" ] }, "accessible_by_public_transport": { "type": "boolean", "description": "Whether the job location is accessible by public transport.", "example": true }, "driving_licenses": { "type": "array", "description": "Array of required driving license codes.", "items": { "type": "string" }, "example": [ "B", "C" ] }, "work_environments": { "type": "array", "description": "Array of work environment codes.", "items": { "type": "string" }, "example": [ "indoor", "outdoor" ] }, "transport_modes": { "type": "array", "description": "Array of transport mode codes.", "items": { "type": "string" }, "example": [ "car", "bike" ] }, "work_schedules": { "type": "array", "description": "Array of work schedule codes.", "items": { "type": "string" }, "example": [ "business_hours", "evenings" ] }, "number_of_seats": { "type": "integer", "nullable": true, "description": "Number of available positions for this vacancy.", "example": 3 }, "foreign_languages": { "type": "array", "description": "Array of foreign language codes (besides Dutch).", "items": { "type": "string" }, "example": [ "en", "de", "fr" ] }, "language_nl": { "type": "object", "description": "Dutch language proficiency requirements.", "properties": { "reading": { "type": "integer", "nullable": true, "description": "Dutch reading proficiency level (-2 to 2).", "example": 1 }, "writing": { "type": "integer", "nullable": true, "description": "Dutch writing proficiency level (-2 to 2).", "example": 0 }, "speaking": { "type": "integer", "nullable": true, "description": "Dutch speaking proficiency level (-2 to 2).", "example": 2 }, "understanding": { "type": "integer", "nullable": true, "description": "Dutch understanding proficiency level (-2 to 2).", "example": 1 } } }, "created_at": { "type": "string", "format": "date-time", "description": "When the vacancy was created.", "example": "2025-06-01T09:00:00+02:00" }, "archived_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the vacancy was archived.", "example": "2023-12-19T20:49:23+02:00" } } }, "relationships": { "type": "object", "description": "Employer vacancy relationships.", "properties": { "employer": { "type": "object", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" }, "contact": { "type": "object", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" }, "contact_management": { "type": "object", "description": "The manager contact associated with this vacancy. References a contact.", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" }, "contact_recruitment": { "type": "object", "description": "The recruiter contact associated with this vacancy. References a contact.", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" }, "account_manager": { "type": "object", "description": "The account manager assigned to this vacancy. References a member.", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "employer_vacancy_dossier": { "type": "object", "description": "Employer Vacancy - Dossier join record", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the employer vacancy dossier.", "example": "789e49a8-8f3b-4c26-8b8b-7d672fadaa92" }, "type": { "type": "string", "default": "employer_vacancy_dossiers" }, "attributes": { "type": "object", "description": "A list of attributes for the employer vacancy dossier.", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "When the employer vacancy dossier was created.", "example": "2025-06-01T09:00:00+02:00" }, "shared_with_employer_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the candidate was shared with the employer contact.", "example": "2025-06-02T09:00:00+02:00" }, "status": { "type": "string", "description": "Current status of the candidate on the vacancy.", "example": "interested" }, "notes": { "type": "string", "nullable": true, "description": "Notes for this candidate on the vacancy.", "example": "Kandidaat besproken; vervolgstappen ..." } }, "required": [ "created_at" ] }, "relationships": { "type": "object", "description": "Employer vacancy dossier relationships.", "properties": { "employer_vacancy": { "type": "object", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" }, "dossier": { "type": "object", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "showroom": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the showroom.", "example": "606276ab-987c-4aab-b20b-9cc62c2656a1" }, "type": { "type": "string", "default": "showrooms" }, "attributes": { "type": "object", "description": "Showroom attributes.", "properties": { "name": { "type": "string", "description": "The name of the showroom.", "example": "Tech Talent Showroom" }, "internal": { "type": "boolean", "description": "Whether the showroom is targeted at internal employees.", "example": false }, "contacts_allowed": { "type": "boolean", "description": "Whether employer contacts can access the showroom.", "example": true } } } }, "required": [ "id", "type", "attributes" ] }, "employer-2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the employer.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "type": "string", "default": "employers" }, "attributes": { "type": "object", "description": "A list of attributes for the employer.", "properties": { "name": { "type": "string", "description": "The name of the employer.", "example": "Big Business BV" }, "branch_total_employees": { "type": "integer", "nullable": true, "description": "The total amount of employees for the employer's branch.", "example": 12 }, "city": { "type": "string", "description": "The city where the employer is located.", "example": "Eindhoven" }, "custom_fields": { "type": "array", "description": "Custom field values for the employer.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The code of the custom employer field.", "example": "industry_type" }, "values": { "type": "array", "description": "Values for the custom employer field.", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "example": [ "IT", "Consulting" ] } } } }, "house_number": { "type": "string", "nullable": true, "description": "The house number of the employer's address.", "example": "12A" }, "latitude": { "type": "number", "format": "float", "nullable": true, "description": "Latitude coordinate of the employer's address.", "example": 51.438862 }, "legal_form": { "type": "string", "nullable": true, "description": "The legal form of this employer.", "example": "Besloten Vennootschap" }, "longitude": { "type": "number", "format": "float", "nullable": true, "description": "Longitude coordinate of the employer's address.", "example": 5.475078 }, "national_branch_id": { "type": "string", "nullable": true, "description": "National branch number of the employer (12-digit KVK \"vestigingsnummer\").", "example": "123456789012" }, "national_id": { "type": "string", "nullable": true, "description": "National ID of the employer (KVK number).", "example": "12345678" }, "postal_code": { "type": "string", "nullable": true, "description": "Postal code of the employer's address.", "example": "5611AZ" }, "total_employees": { "type": "integer", "nullable": true, "description": "The total amount of employees for the employer's company.", "example": 100 }, "sbi_codes": { "type": "array", "nullable": true, "description": "The SBI Codes of this employer.", "items": { "type": "string" }, "example": [ "6201", "6321" ] }, "street": { "type": "string", "nullable": true, "description": "Street name of the employer's address.", "example": "Emmastraat" }, "created_at": { "type": "string", "format": "date-time", "description": "Time of the employer's creation.\n", "example": "2023-12-19T20:49:23+02:00" }, "archived_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when the employer was archived.\n", "example": "2023-12-19T20:49:23+02:00" } }, "required": [ "name", "city", "custom_fields", "house_number", "latitude", "longitude", "national_branch_id", "national_id", "postal_code", "street" ] }, "relationships": { "type": "object", "description": "Employer relationships.", "properties": { "account_managers": { "type": "object", "description": "List of account managers for the employer. References members.", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/relationship" } } } }, "primary_account_manager": { "type": "object", "description": "The primary account manager for the employer. References a member.", "properties": { "data": null }, "$ref": "#/components/schemas/relationship" }, "account_manager": { "type": "object", "description": "References a member.", "deprecated": true, "properties": { "data": null }, "$ref": "#/components/schemas/relationship" } } } } }, "task": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the task.", "example": "be811f91-21fb-4ea6-ac9f-ab4731b80331" }, "type": { "type": "string", "default": "tasks" }, "attributes": { "type": "object", "description": "Task attributes.", "properties": { "task_type": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the task type.", "example": "Plaatsing" }, "code": { "type": "string", "enum": [ "intake", "fill_profile", "analyse_profile", "action_plan", "job_orientation", "training", "job_applications", "progress_report", "placement", "follow_up", "report", "other", "collaboration", "vacancy_discussion", "hr_advice" ], "description": "The internal code of the task type.", "example": "placement" } } }, "description": { "type": "string", "description": "The description of the task.", "example": "Exit gesprek met kees ingeplannen." }, "title": { "type": "string", "description": "The title of the note.", "example": "nazorg" }, "completed_at": { "type": "string", "format": "date-time", "description": "When the task was completed.", "example": "2025-06-01T09:00:00+02:00" }, "expires_at": { "type": "string", "format": "date-time", "description": "When the task is due.", "example": "2025-06-16T10:00:00+02:00" }, "created_at": { "type": "string", "format": "date-time", "description": "When the task was created.", "example": "2025-06-01T09:00:00+02:00" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the task was last updated.", "example": "2025-06-16T10:00:00+02:00" } } }, "relationships": { "type": "object", "description": "Task relationships.", "properties": { "owner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } }, "created_by": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } }, "completed_by": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } }, "subject": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/relationship" } } } } } }, "required": [ "id", "type", "attributes", "relationships" ] }, "track-2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the track.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "type": "string", "default": "tracks" }, "attributes": { "type": "object", "description": "A list of attributes for the track.", "properties": { "name": { "type": "string", "description": "The name of the track.", "example": "Re-integratietraject" }, "description": { "type": "string", "nullable": true, "description": "The description of the track.", "example": "Een traject gericht op re-integratie in het arbeidsproces." } }, "required": [ "name" ] } }, "required": [ "id", "type", "attributes" ] } } }, "x-tagGroups": [ { "name": "Information", "tags": [ "Introduction", "Authentication" ] }, { "name": "Endpoints: Authentication", "tags": [ "User Tokens", "One-time SSO URLs" ] }, { "name": "Endpoints: Resources", "tags": [ "User Contexts", "Conversations", "Dossiers", "Employers", "Notifications", "Employer Vacancies", "Saved Vacancies", "Contacts", "Tracks", "Custom Fields" ] }, { "name": "Endpoints: Export", "tags": [ "Exported formats", "Export resources", "Export taxonomy" ] }, { "name": "Other", "tags": [ "Changelog" ] } ] }