{"openapi":"3.0.3","info":{"title":"CV-Transformer API","description":"Access and manage your CV-Transformer data. Authenticate with an API key as a bearer token: `Authorization: Bearer YOUR_API_KEY`, or, for apps acting for a user, with an OAuth access token. A key can be limited to scopes: requests outside them get a 403, and embedded resources outside them come back empty. Each operation names the scope it needs in `x-scope`. Each key may make 120 requests per minute unless agreed otherwise.","version":"14.5"},"externalDocs":{"description":"CV-Transformer API reference","url":"https://www.cv-transformer.com/en/api-reference"},"servers":[{"url":"https://api.cv-transformer.com/v1"}],"security":[{"apiKey":[]},{"oauth2":[]}],"paths":{"/api_requests":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.api_requests.id"},{"$ref":"#/components/parameters/rowFilter.api_requests.api_key_id"},{"$ref":"#/components/parameters/rowFilter.api_requests.created_at"},{"$ref":"#/components/parameters/rowFilter.api_requests.endpoint"},{"$ref":"#/components/parameters/rowFilter.api_requests.method"},{"$ref":"#/components/parameters/rowFilter.api_requests.created_on"},{"$ref":"#/components/parameters/rowFilter.api_requests.search"},{"$ref":"#/components/parameters/rowFilter.api_requests.status"},{"$ref":"#/components/parameters/rowFilter.api_requests.grant_id"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":0,"api_key_id":"00000000-0000-0000-0000-000000000000","grant_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","created_on":"2026-01-01","endpoint":"","method":"","search":"","status":0}],"schema":{"items":{"$ref":"#/components/schemas/api_requests"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column api_requests.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the organization:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"tags":["api_requests"],"description":"Requires the `organization:read` scope.","security":[{"apiKey":[]},{"oauth2":["organization:read"]}],"x-scope":"organization:read"}},"/billing_accounts":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.billing_accounts.id"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.created_at"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.updated_at"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.credit"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.currency"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.minimum_guarantee"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.next_billed_at"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.paddle_subscription_id"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.prev_usage"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.price_per_credit"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.pricing_version"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.recent_usage"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.subscription_type"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.trial_expires_at"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.user_licenses"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.price_per_user"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.maximum_usage"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.allow_pre_paid"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.overage_billed_for"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":"00000000-0000-0000-0000-000000000000","paddle_subscription_id":"sub_01h8bx3z9k7mq2w4e6r8t0y2u4","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","allow_pre_paid":false,"credit":0,"currency":"USD","maximum_usage":0,"minimum_guarantee":0,"overage_billed_for":"","prev_usage":0,"price_per_credit":0,"price_per_user":0,"pricing_version":"v3","recent_usage":0,"subscription_type":"subscription","trial_expires_at":null,"user_licenses":0}],"schema":{"items":{"$ref":"#/components/schemas/billing_accounts"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column billing_accounts.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the organization:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"tags":["billing_accounts"],"description":"Requires the `organization:read` scope.","security":[{"apiKey":[]},{"oauth2":["organization:read"]}],"x-scope":"organization:read"},"patch":{"parameters":[{"$ref":"#/components/parameters/rowFilter.billing_accounts.id"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.created_at"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.updated_at"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.credit"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.currency"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.minimum_guarantee"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.next_billed_at"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.paddle_subscription_id"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.prev_usage"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.price_per_credit"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.pricing_version"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.recent_usage"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.subscription_type"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.trial_expires_at"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.user_licenses"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.price_per_user"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.maximum_usage"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.allow_pre_paid"},{"$ref":"#/components/parameters/rowFilter.billing_accounts.overage_billed_for"},{"$ref":"#/components/parameters/preferReturn"}],"requestBody":{"$ref":"#/components/requestBodies/body.billing_accounts"},"responses":{"204":{"description":"No Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column, an invalid filter or an invalid body.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column billing_accounts.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the organization:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.","content":{"application/json":{"example":{"code":"23505","details":"Key (id)=(00000000-0000-0000-0000-000000000000) already exists.","hint":null,"message":"duplicate key value violates unique constraint \"billing_accounts_pkey\""},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"tags":["billing_accounts"],"description":"Requires the `organization:write` scope.","security":[{"apiKey":[]},{"oauth2":["organization:write"]}],"x-scope":"organization:write"}},"/candidate_analytics":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.candidate_analytics.id"},{"$ref":"#/components/parameters/rowFilter.candidate_analytics.created_at"},{"$ref":"#/components/parameters/rowFilter.candidate_analytics.updated_at"},{"$ref":"#/components/parameters/rowFilter.candidate_analytics.candidate_id"},{"$ref":"#/components/parameters/rowFilter.candidate_analytics.organization_id"},{"$ref":"#/components/parameters/rowFilter.candidate_analytics.time_spent"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":"00000000-0000-0000-0000-000000000000","candidate_id":"00000000-0000-0000-0000-000000000000","organization_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","time_spent":0}],"schema":{"items":{"$ref":"#/components/schemas/candidate_analytics"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column candidate_analytics.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the candidates:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"tags":["candidate_analytics"],"description":"Requires the `candidates:read` scope.","security":[{"apiKey":[]},{"oauth2":["candidates:read"]}],"x-scope":"candidates:read"}},"/candidate_views":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.candidate_views.id"},{"$ref":"#/components/parameters/rowFilter.candidate_views.candidate_id"},{"$ref":"#/components/parameters/rowFilter.candidate_views.created_at"},{"$ref":"#/components/parameters/rowFilter.candidate_views.anonymous"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":0,"candidate_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","anonymous":false}],"schema":{"items":{"$ref":"#/components/schemas/candidate_views"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column candidate_views.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the candidates:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Logs for each time a candidate is viewed","tags":["candidate_views"],"description":"Requires the `candidates:read` scope.","security":[{"apiKey":[]},{"oauth2":["candidates:read"]}],"x-scope":"candidates:read"}},"/candidates":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.candidates.id"},{"$ref":"#/components/parameters/rowFilter.candidates.created_at"},{"$ref":"#/components/parameters/rowFilter.candidates.organization_id"},{"$ref":"#/components/parameters/rowFilter.candidates.updated_at"},{"$ref":"#/components/parameters/rowFilter.candidates.status"},{"$ref":"#/components/parameters/rowFilter.candidates.secret"},{"$ref":"#/components/parameters/rowFilter.candidates.secret_anonymous"},{"$ref":"#/components/parameters/rowFilter.candidates.layout_id"},{"$ref":"#/components/parameters/rowFilter.candidates.values"},{"$ref":"#/components/parameters/rowFilter.candidates.language"},{"$ref":"#/components/parameters/rowFilter.candidates.member_id"},{"$ref":"#/components/parameters/rowFilter.candidates.attachments"},{"$ref":"#/components/parameters/rowFilter.candidates.name"},{"$ref":"#/components/parameters/rowFilter.candidates.avatar"},{"$ref":"#/components/parameters/rowFilter.candidates.secret_editable"},{"$ref":"#/components/parameters/rowFilter.candidates.deleted_at"},{"$ref":"#/components/parameters/rowFilter.candidates.export_filename"},{"$ref":"#/components/parameters/rowFilter.candidates.external_data"},{"$ref":"#/components/parameters/rowFilter.candidates.messages"},{"$ref":"#/components/parameters/rowFilter.candidates.section_attachments"},{"$ref":"#/components/parameters/rowFilter.candidates.fts"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":"00000000-0000-0000-0000-000000000000","layout_id":"00000000-0000-0000-0000-000000000000","member_id":"00000000-0000-0000-0000-000000000000","organization_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","deleted_at":null,"attachments":{"CV":{"detected_source_language":null,"external_id":null,"label":"CV","text":{"default":"Text from the attachment"},"type":"pdf","url":"https://ddcaybdkekwxbpgpotoa.supabase.co/storage/v1/object/public/common/organizations/00000000-0000-0000-0000-000000000000/document.pdf"}},"avatar":"","export_filename":"","external_data":{"avatar":"https://example.com/candidates/123/avatar.jpg","name":"John Doe","id":"123","url":"https://integration.com/candidates/123","values":{"first_name":"John","last_name":"Doe"}},"fts":"'doe':2 'john':1","language":"en","messages":[{"comment":"Filled in values","created_at":"2026-11-13T03:03:50.187Z","id":"00000000-0000-0000-0000-000000000000","member_id":"00000000-0000-0000-0000-000000000000","prompt":"Fill in values","selector":[]}],"name":"","secret":"","secret_anonymous":"","secret_editable":"","section_attachments":{},"status":"active","values":{"name":"John Doe","date_of_birth":"1995-01-01","experiences":[{"interval":{"start":"2015-01-01","end":"2018-01-01"},"company":"Example Inc.","position":"Developer"}]}}],"schema":{"items":{"$ref":"#/components/schemas/candidates"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column candidates.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the candidates:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"All information related to individual candidates","tags":["candidates"],"description":"Requires the `candidates:read` scope.","security":[{"apiKey":[]},{"oauth2":["candidates:read"]}],"x-scope":"candidates:read"},"delete":{"parameters":[{"$ref":"#/components/parameters/rowFilter.candidates.id"},{"$ref":"#/components/parameters/rowFilter.candidates.created_at"},{"$ref":"#/components/parameters/rowFilter.candidates.organization_id"},{"$ref":"#/components/parameters/rowFilter.candidates.updated_at"},{"$ref":"#/components/parameters/rowFilter.candidates.status"},{"$ref":"#/components/parameters/rowFilter.candidates.secret"},{"$ref":"#/components/parameters/rowFilter.candidates.secret_anonymous"},{"$ref":"#/components/parameters/rowFilter.candidates.layout_id"},{"$ref":"#/components/parameters/rowFilter.candidates.values"},{"$ref":"#/components/parameters/rowFilter.candidates.language"},{"$ref":"#/components/parameters/rowFilter.candidates.member_id"},{"$ref":"#/components/parameters/rowFilter.candidates.attachments"},{"$ref":"#/components/parameters/rowFilter.candidates.name"},{"$ref":"#/components/parameters/rowFilter.candidates.avatar"},{"$ref":"#/components/parameters/rowFilter.candidates.secret_editable"},{"$ref":"#/components/parameters/rowFilter.candidates.deleted_at"},{"$ref":"#/components/parameters/rowFilter.candidates.export_filename"},{"$ref":"#/components/parameters/rowFilter.candidates.external_data"},{"$ref":"#/components/parameters/rowFilter.candidates.messages"},{"$ref":"#/components/parameters/rowFilter.candidates.section_attachments"},{"$ref":"#/components/parameters/rowFilter.candidates.fts"},{"$ref":"#/components/parameters/preferReturn"}],"responses":{"204":{"description":"No Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column candidates.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the candidates:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"All information related to individual candidates","tags":["candidates"],"description":"Requires the `candidates:write` scope.","security":[{"apiKey":[]},{"oauth2":["candidates:write"]}],"x-scope":"candidates:write"},"patch":{"parameters":[{"$ref":"#/components/parameters/rowFilter.candidates.id"},{"$ref":"#/components/parameters/rowFilter.candidates.created_at"},{"$ref":"#/components/parameters/rowFilter.candidates.organization_id"},{"$ref":"#/components/parameters/rowFilter.candidates.updated_at"},{"$ref":"#/components/parameters/rowFilter.candidates.status"},{"$ref":"#/components/parameters/rowFilter.candidates.secret"},{"$ref":"#/components/parameters/rowFilter.candidates.secret_anonymous"},{"$ref":"#/components/parameters/rowFilter.candidates.layout_id"},{"$ref":"#/components/parameters/rowFilter.candidates.values"},{"$ref":"#/components/parameters/rowFilter.candidates.language"},{"$ref":"#/components/parameters/rowFilter.candidates.member_id"},{"$ref":"#/components/parameters/rowFilter.candidates.attachments"},{"$ref":"#/components/parameters/rowFilter.candidates.name"},{"$ref":"#/components/parameters/rowFilter.candidates.avatar"},{"$ref":"#/components/parameters/rowFilter.candidates.secret_editable"},{"$ref":"#/components/parameters/rowFilter.candidates.deleted_at"},{"$ref":"#/components/parameters/rowFilter.candidates.export_filename"},{"$ref":"#/components/parameters/rowFilter.candidates.external_data"},{"$ref":"#/components/parameters/rowFilter.candidates.messages"},{"$ref":"#/components/parameters/rowFilter.candidates.section_attachments"},{"$ref":"#/components/parameters/rowFilter.candidates.fts"},{"$ref":"#/components/parameters/preferReturn"}],"requestBody":{"$ref":"#/components/requestBodies/body.candidates"},"responses":{"204":{"description":"No Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column, an invalid filter or an invalid body.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column candidates.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the candidates:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.","content":{"application/json":{"example":{"code":"23505","details":"Key (id)=(00000000-0000-0000-0000-000000000000) already exists.","hint":null,"message":"duplicate key value violates unique constraint \"candidates_pkey\""},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"All information related to individual candidates","tags":["candidates"],"description":"Requires the `candidates:write` scope.","security":[{"apiKey":[]},{"oauth2":["candidates:write"]}],"x-scope":"candidates:write"},"post":{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attachments":{"default":{},"description":"Files attached to the candidate, by key","type":"object","additionalProperties":{"type":"object","properties":{"detected_source_language":{"nullable":true,"type":"string"},"external_id":{"nullable":true,"anyOf":[{"type":"string"},{"type":"number"}]},"label":{"type":"string"},"text":{"$ref":"#/components/schemas/MultiLanguageString"},"type":{"type":"string","enum":["image","image-pdf","link","pdf","text"]},"url":{"type":"string"}},"required":["detected_source_language","external_id","label","text","type","url"]}},"external_data":{"default":null,"description":"Data imported from an external source","nullable":true,"type":"object","properties":{"avatar":{"nullable":true,"type":"string"},"name":{"type":"string"},"id":{"anyOf":[{"type":"string"},{"type":"number"}]},"url":{"type":"string"},"values":{}},"required":["avatar","name","id","url"]},"language":{"allOf":[{"$ref":"#/components/schemas/Language"}],"default":null,"description":"Language the candidate is displayed in. Defaults to the layout's first language","nullable":true},"layout_id":{"default":null,"description":"Identifier of a layout of the organization. Defaults to the organization's default layout, also when the layout doesn't exist","nullable":true,"type":"string"},"member_external_id":{"default":null,"description":"The ID of the member in an external system, to find the member by when `member_id` is not set","nullable":true,"type":"string"},"member_id":{"default":null,"description":"Identifier of the member of the organization associated with the candidate. No member when it doesn't exist","nullable":true,"type":"string"},"values":{"default":null,"description":"Values for the variables defined in the layout","nullable":true,"type":"object","additionalProperties":{}}}}}},"required":true},"responses":{"201":{"description":"The created candidate","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":{"id":"00000000-0000-0000-0000-000000000000","layout_id":"00000000-0000-0000-0000-000000000000","member_id":"00000000-0000-0000-0000-000000000000","organization_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","deleted_at":null,"attachments":{"CV":{"detected_source_language":null,"external_id":null,"label":"CV","text":{"default":"Text from the attachment"},"type":"pdf","url":"https://ddcaybdkekwxbpgpotoa.supabase.co/storage/v1/object/public/common/organizations/00000000-0000-0000-0000-000000000000/document.pdf"}},"avatar":"","export_filename":"","external_data":{"avatar":"https://example.com/candidates/123/avatar.jpg","name":"John Doe","id":"123","url":"https://integration.com/candidates/123","values":{"first_name":"John","last_name":"Doe"}},"fts":"'doe':2 'john':1","language":"en","messages":[{"comment":"Filled in values","created_at":"2026-11-13T03:03:50.187Z","id":"00000000-0000-0000-0000-000000000000","member_id":"00000000-0000-0000-0000-000000000000","prompt":"Fill in values","selector":[]}],"name":"","secret":"","secret_anonymous":"","secret_editable":"","section_attachments":{},"status":"active","values":{"name":"John Doe","date_of_birth":"1995-01-01","experiences":[{"interval":{"start":"2015-01-01","end":"2018-01-01"},"company":"Example Inc.","position":"Developer"}]}},"schema":{"$ref":"#/components/schemas/candidates"}}}},"400":{"description":"The body is invalid: not JSON, a required field is missing or a field has the wrong type or value. The details name each invalid field and why.","content":{"application/json":{"example":{"details":"attachments.CV.url: A link's url must be an http(s) URL; a file's url must be in our storage (upload it with /candidates/{candidate_id}/attach)","hint":null,"message":"The request body is invalid"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the candidates:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Create a candidate","tags":["candidates"],"description":"Requires the `candidates:write` scope.","security":[{"apiKey":[]},{"oauth2":["candidates:write"]}],"x-scope":"candidates:write"}},"/candidates/{candidate_id}/attach":{"post":{"parameters":[{"description":"The identifier of the candidate.","in":"path","name":"candidate_id","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"description":"Label of the attachment, like CV or Vacancy. Defaults to CV.","in":"query","name":"location","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"The file to attach: a PDF, Word document, image or text file.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"required":true},"responses":{"200":{"description":"The updated candidate","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":{"id":"00000000-0000-0000-0000-000000000000","layout_id":"00000000-0000-0000-0000-000000000000","member_id":"00000000-0000-0000-0000-000000000000","organization_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","deleted_at":null,"attachments":{"CV":{"detected_source_language":null,"external_id":null,"label":"CV","text":{"default":"Text from the attachment"},"type":"pdf","url":"https://ddcaybdkekwxbpgpotoa.supabase.co/storage/v1/object/public/common/organizations/00000000-0000-0000-0000-000000000000/document.pdf"}},"avatar":"","export_filename":"","external_data":{"avatar":"https://example.com/candidates/123/avatar.jpg","name":"John Doe","id":"123","url":"https://integration.com/candidates/123","values":{"first_name":"John","last_name":"Doe"}},"fts":"'doe':2 'john':1","language":"en","messages":[{"comment":"Filled in values","created_at":"2026-11-13T03:03:50.187Z","id":"00000000-0000-0000-0000-000000000000","member_id":"00000000-0000-0000-0000-000000000000","prompt":"Fill in values","selector":[]}],"name":"","secret":"","secret_anonymous":"","secret_editable":"","section_attachments":{},"status":"active","values":{"name":"John Doe","date_of_birth":"1995-01-01","experiences":[{"interval":{"start":"2015-01-01","end":"2018-01-01"},"company":"Example Inc.","position":"Developer"}]}},"schema":{"$ref":"#/components/schemas/candidates"}}}},"400":{"description":"The file type isn't supported.","content":{"text/plain":{"example":"Unsupported file type text/csv","schema":{"type":"string"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the candidates:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The candidate doesn't exist in the API key's organization.","content":{"application/json":{"example":{"details":null,"hint":null,"message":"Not found"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Upload a candidate attachment","tags":["candidates"],"description":"Requires the `candidates:write` scope.","security":[{"apiKey":[]},{"oauth2":["candidates:write"]}],"x-scope":"candidates:write"}},"/candidates/{candidate_id}/extract":{"post":{"parameters":[{"description":"The identifier of the candidate.","in":"path","name":"candidate_id","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{},"description":"A JSON schema describing the data to extract from the candidate's attachments."}}},"required":true},"responses":{"200":{"description":"The extracted data, following the JSON schema","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":{"email":"john.doe@example.com","experiences":[{"company":"Example Inc.","position":"Developer"}],"name":"John Doe"},"schema":{"type":"object","additionalProperties":{}}}}},"400":{"description":"The candidate has no attachments with text.","content":{"text/plain":{"example":"Candidate has no usable attachments","schema":{"type":"string"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the candidates:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The candidate doesn't exist in the API key's organization.","content":{"application/json":{"example":{"details":null,"hint":null,"message":"Not found"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Extract candidate data","tags":["candidates"],"description":"Requires the `candidates:read` scope.","security":[{"apiKey":[]},{"oauth2":["candidates:read"]}],"x-scope":"candidates:read"}},"/candidates/{candidate_id}/fill":{"post":{"parameters":[{"description":"The identifier of the candidate.","in":"path","name":"candidate_id","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"description":"Custom prompt, e.g. \"Expand introduction\", \"Sort skills by level\". Organization's default prompt is used when left empty.","in":"query","name":"prompt","required":false,"schema":{"type":"string"}},{"description":"JSON selector to which the prompt should be applied, e.g. `[\"experiences\", 0]` to apply the prompt to the first experience. Repeat the parameter for each part. If left empty, the prompt is applied to the entire candidate.","in":"query","name":"selector","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The updated candidate","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":{"id":"00000000-0000-0000-0000-000000000000","layout_id":"00000000-0000-0000-0000-000000000000","member_id":"00000000-0000-0000-0000-000000000000","organization_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","deleted_at":null,"attachments":{"CV":{"detected_source_language":null,"external_id":null,"label":"CV","text":{"default":"Text from the attachment"},"type":"pdf","url":"https://ddcaybdkekwxbpgpotoa.supabase.co/storage/v1/object/public/common/organizations/00000000-0000-0000-0000-000000000000/document.pdf"}},"avatar":"","export_filename":"","external_data":{"avatar":"https://example.com/candidates/123/avatar.jpg","name":"John Doe","id":"123","url":"https://integration.com/candidates/123","values":{"first_name":"John","last_name":"Doe"}},"fts":"'doe':2 'john':1","language":"en","messages":[{"comment":"Filled in values","created_at":"2026-11-13T03:03:50.187Z","id":"00000000-0000-0000-0000-000000000000","member_id":"00000000-0000-0000-0000-000000000000","prompt":"Fill in values","selector":[]}],"name":"","secret":"","secret_anonymous":"","secret_editable":"","section_attachments":{},"status":"active","values":{"name":"John Doe","date_of_birth":"1995-01-01","experiences":[{"interval":{"start":"2015-01-01","end":"2018-01-01"},"company":"Example Inc.","position":"Developer"}]}},"schema":{"$ref":"#/components/schemas/candidates"}}}},"400":{"description":"The candidate has no layout.","content":{"text/plain":{"example":"Candidate is missing layout","schema":{"type":"string"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the candidates:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The candidate doesn't exist in the API key's organization.","content":{"application/json":{"example":{"details":null,"hint":null,"message":"Not found"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Fill or adjust candidate data","tags":["candidates"],"description":"Requires the `candidates:write` scope.","security":[{"apiKey":[]},{"oauth2":["candidates:write"]}],"x-scope":"candidates:write"}},"/credit_mutations":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.credit_mutations.id"},{"$ref":"#/components/parameters/rowFilter.credit_mutations.created_at"},{"$ref":"#/components/parameters/rowFilter.credit_mutations.organization_id"},{"$ref":"#/components/parameters/rowFilter.credit_mutations.delta"},{"$ref":"#/components/parameters/rowFilter.credit_mutations.billing_account_id"},{"$ref":"#/components/parameters/rowFilter.credit_mutations.paddle_transaction_id"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":"00000000-0000-0000-0000-000000000000","billing_account_id":"00000000-0000-0000-0000-000000000000","organization_id":"00000000-0000-0000-0000-000000000000","paddle_transaction_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","delta":0}],"schema":{"items":{"$ref":"#/components/schemas/credit_mutations"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column credit_mutations.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the organization:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Changes in credit per organization","tags":["credit_mutations"],"description":"Requires the `organization:read` scope.","security":[{"apiKey":[]},{"oauth2":["organization:read"]}],"x-scope":"organization:read"}},"/layouts":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.layouts.id"},{"$ref":"#/components/parameters/rowFilter.layouts.created_at"},{"$ref":"#/components/parameters/rowFilter.layouts.creator_id"},{"$ref":"#/components/parameters/rowFilter.layouts.organization_id"},{"$ref":"#/components/parameters/rowFilter.layouts.updated_at"},{"$ref":"#/components/parameters/rowFilter.layouts.name"},{"$ref":"#/components/parameters/rowFilter.layouts.fts"},{"$ref":"#/components/parameters/rowFilter.layouts.thumbnail"},{"$ref":"#/components/parameters/rowFilter.layouts.visibility"},{"$ref":"#/components/parameters/rowFilter.layouts.secret"},{"$ref":"#/components/parameters/rowFilter.layouts.parent_id"},{"$ref":"#/components/parameters/rowFilter.layouts.tokens"},{"$ref":"#/components/parameters/rowFilter.layouts.sections"},{"$ref":"#/components/parameters/rowFilter.layouts.featured"},{"$ref":"#/components/parameters/rowFilter.layouts.slug"},{"$ref":"#/components/parameters/rowFilter.layouts.variables"},{"$ref":"#/components/parameters/rowFilter.layouts.default_values"},{"$ref":"#/components/parameters/rowFilter.layouts.languages"},{"$ref":"#/components/parameters/rowFilter.layouts.assets"},{"$ref":"#/components/parameters/rowFilter.layouts.export_filename"},{"$ref":"#/components/parameters/rowFilter.layouts.share_instructions"},{"$ref":"#/components/parameters/rowFilter.layouts.web_settings"},{"$ref":"#/components/parameters/rowFilter.layouts.archived_at"},{"$ref":"#/components/parameters/rowFilter.layouts.description"},{"$ref":"#/components/parameters/rowFilter.layouts.page_height"},{"$ref":"#/components/parameters/rowFilter.layouts.page_width"},{"$ref":"#/components/parameters/rowFilter.layouts.custom_css"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":"00000000-0000-0000-0000-000000000000","creator_id":"00000000-0000-0000-0000-000000000000","organization_id":"00000000-0000-0000-0000-000000000000","parent_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","archived_at":null,"assets":[{"family":"Roboto","type":"font","url":"https://ddcaybdkekwxbpgpotoa.supabase.co/storage/v1/object/public/common/organizations/00000000-0000-0000-0000-000000000000/roboto.ttf"},{"label":"Example","type":"image","url":"https://ddcaybdkekwxbpgpotoa.supabase.co/storage/v1/object/public/common/organizations/00000000-0000-0000-0000-000000000000/example.png"}],"custom_css":"","default_values":{"en":{"message":"Hello"},"nl":{"message":"Hallo"}},"description":"","export_filename":"","featured":false,"fts":"'doe':2 'john':1","languages":["en","cs","da-DK","de","en-GB","es","fr","ja-JP","nb-NO","nl","pt-BR","sv-SE","yue","zh"],"name":"","page_height":0,"page_width":0,"secret":"00000000-0000-0000-0000-000000000000","sections":[{"body":{"align":"left","background":"#FFFFFF","bold":false,"border":null,"borderRadius":"0","color":"#000000","columns":1,"font":{"family":"Roboto","letter_spacing":0,"line_height":1.5,"paragraph_spacing":0.5,"size":16},"grow":true,"id":"text","italic":false,"margin":"0","padding":16,"listStyle":"disc","split":false,"strikethrough":false,"textTransform":"none","transform":"","underline":false,"value":{"default":"Hello","nl":"Hallo"},"visibility":true,"type":"text"},"footer":null,"header":null,"id":"section","label":"Section","type":"multi-page"}],"share_instructions":"","slug":"","thumbnail":"","tokens":[{"id":"primary-color","name":"Primary color","type":"color","value":"#000000"},{"id":"font-size","name":"Font size","type":"length","value":16}],"variables":[{"ai_instructions":"","sensitive":false,"default":"","key":"name","max_length":null,"min_length":0,"type":"inline-text"},{"ai_instructions":"","sensitive":false,"default":"","key":"description","max_length":null,"min_length":0,"type":"text-block"}],"visibility":"public","web_settings":{"color_accent":"#000000","color_background":"#FFFFFF","color_text":"#000000"}}],"schema":{"items":{"$ref":"#/components/schemas/layouts"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column layouts.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the layouts:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Layout definitions that can be filled in per candidate","tags":["layouts"],"description":"Requires the `layouts:read` scope.","security":[{"apiKey":[]},{"oauth2":["layouts:read"]}],"x-scope":"layouts:read"},"post":{"parameters":[{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/preferPost"}],"requestBody":{"$ref":"#/components/requestBodies/body.layouts"},"responses":{"201":{"description":"Created","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column, an invalid filter or an invalid body.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column layouts.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the layouts:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.","content":{"application/json":{"example":{"code":"23505","details":"Key (id)=(00000000-0000-0000-0000-000000000000) already exists.","hint":null,"message":"duplicate key value violates unique constraint \"layouts_pkey\""},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Layout definitions that can be filled in per candidate","tags":["layouts"],"description":"Requires the `layouts:write` scope.","security":[{"apiKey":[]},{"oauth2":["layouts:write"]}],"x-scope":"layouts:write"},"delete":{"parameters":[{"$ref":"#/components/parameters/rowFilter.layouts.id"},{"$ref":"#/components/parameters/rowFilter.layouts.created_at"},{"$ref":"#/components/parameters/rowFilter.layouts.creator_id"},{"$ref":"#/components/parameters/rowFilter.layouts.organization_id"},{"$ref":"#/components/parameters/rowFilter.layouts.updated_at"},{"$ref":"#/components/parameters/rowFilter.layouts.name"},{"$ref":"#/components/parameters/rowFilter.layouts.fts"},{"$ref":"#/components/parameters/rowFilter.layouts.thumbnail"},{"$ref":"#/components/parameters/rowFilter.layouts.visibility"},{"$ref":"#/components/parameters/rowFilter.layouts.secret"},{"$ref":"#/components/parameters/rowFilter.layouts.parent_id"},{"$ref":"#/components/parameters/rowFilter.layouts.tokens"},{"$ref":"#/components/parameters/rowFilter.layouts.sections"},{"$ref":"#/components/parameters/rowFilter.layouts.featured"},{"$ref":"#/components/parameters/rowFilter.layouts.slug"},{"$ref":"#/components/parameters/rowFilter.layouts.variables"},{"$ref":"#/components/parameters/rowFilter.layouts.default_values"},{"$ref":"#/components/parameters/rowFilter.layouts.languages"},{"$ref":"#/components/parameters/rowFilter.layouts.assets"},{"$ref":"#/components/parameters/rowFilter.layouts.export_filename"},{"$ref":"#/components/parameters/rowFilter.layouts.share_instructions"},{"$ref":"#/components/parameters/rowFilter.layouts.web_settings"},{"$ref":"#/components/parameters/rowFilter.layouts.archived_at"},{"$ref":"#/components/parameters/rowFilter.layouts.description"},{"$ref":"#/components/parameters/rowFilter.layouts.page_height"},{"$ref":"#/components/parameters/rowFilter.layouts.page_width"},{"$ref":"#/components/parameters/rowFilter.layouts.custom_css"},{"$ref":"#/components/parameters/preferReturn"}],"responses":{"204":{"description":"No Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column layouts.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the layouts:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Layout definitions that can be filled in per candidate","tags":["layouts"],"description":"Requires the `layouts:write` scope.","security":[{"apiKey":[]},{"oauth2":["layouts:write"]}],"x-scope":"layouts:write"},"patch":{"parameters":[{"$ref":"#/components/parameters/rowFilter.layouts.id"},{"$ref":"#/components/parameters/rowFilter.layouts.created_at"},{"$ref":"#/components/parameters/rowFilter.layouts.creator_id"},{"$ref":"#/components/parameters/rowFilter.layouts.organization_id"},{"$ref":"#/components/parameters/rowFilter.layouts.updated_at"},{"$ref":"#/components/parameters/rowFilter.layouts.name"},{"$ref":"#/components/parameters/rowFilter.layouts.fts"},{"$ref":"#/components/parameters/rowFilter.layouts.thumbnail"},{"$ref":"#/components/parameters/rowFilter.layouts.visibility"},{"$ref":"#/components/parameters/rowFilter.layouts.secret"},{"$ref":"#/components/parameters/rowFilter.layouts.parent_id"},{"$ref":"#/components/parameters/rowFilter.layouts.tokens"},{"$ref":"#/components/parameters/rowFilter.layouts.sections"},{"$ref":"#/components/parameters/rowFilter.layouts.featured"},{"$ref":"#/components/parameters/rowFilter.layouts.slug"},{"$ref":"#/components/parameters/rowFilter.layouts.variables"},{"$ref":"#/components/parameters/rowFilter.layouts.default_values"},{"$ref":"#/components/parameters/rowFilter.layouts.languages"},{"$ref":"#/components/parameters/rowFilter.layouts.assets"},{"$ref":"#/components/parameters/rowFilter.layouts.export_filename"},{"$ref":"#/components/parameters/rowFilter.layouts.share_instructions"},{"$ref":"#/components/parameters/rowFilter.layouts.web_settings"},{"$ref":"#/components/parameters/rowFilter.layouts.archived_at"},{"$ref":"#/components/parameters/rowFilter.layouts.description"},{"$ref":"#/components/parameters/rowFilter.layouts.page_height"},{"$ref":"#/components/parameters/rowFilter.layouts.page_width"},{"$ref":"#/components/parameters/rowFilter.layouts.custom_css"},{"$ref":"#/components/parameters/preferReturn"}],"requestBody":{"$ref":"#/components/requestBodies/body.layouts"},"responses":{"204":{"description":"No Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column, an invalid filter or an invalid body.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column layouts.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the layouts:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.","content":{"application/json":{"example":{"code":"23505","details":"Key (id)=(00000000-0000-0000-0000-000000000000) already exists.","hint":null,"message":"duplicate key value violates unique constraint \"layouts_pkey\""},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Layout definitions that can be filled in per candidate","tags":["layouts"],"description":"Requires the `layouts:write` scope.","security":[{"apiKey":[]},{"oauth2":["layouts:write"]}],"x-scope":"layouts:write"}},"/members":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.members.organization_id"},{"$ref":"#/components/parameters/rowFilter.members.user_id"},{"$ref":"#/components/parameters/rowFilter.members.created_at"},{"$ref":"#/components/parameters/rowFilter.members.id"},{"$ref":"#/components/parameters/rowFilter.members.updated_at"},{"$ref":"#/components/parameters/rowFilter.members.values"},{"$ref":"#/components/parameters/rowFilter.members.permissions"},{"$ref":"#/components/parameters/rowFilter.members.external_id"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":"00000000-0000-0000-0000-000000000000","external_id":"example-id","organization_id":"00000000-0000-0000-0000-000000000000","user_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","permissions":["billing","edit_candidates","edit_layouts","settings","team","view_candidates"],"values":{"first_name":"John","last_name":"Doe"}}],"schema":{"items":{"$ref":"#/components/schemas/members"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column members.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the members:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Links users to organizations via roles","tags":["members"],"description":"Requires the `members:read` scope.","security":[{"apiKey":[]},{"oauth2":["members:read"]}],"x-scope":"members:read"},"patch":{"parameters":[{"$ref":"#/components/parameters/rowFilter.members.organization_id"},{"$ref":"#/components/parameters/rowFilter.members.user_id"},{"$ref":"#/components/parameters/rowFilter.members.created_at"},{"$ref":"#/components/parameters/rowFilter.members.id"},{"$ref":"#/components/parameters/rowFilter.members.updated_at"},{"$ref":"#/components/parameters/rowFilter.members.values"},{"$ref":"#/components/parameters/rowFilter.members.permissions"},{"$ref":"#/components/parameters/rowFilter.members.external_id"},{"$ref":"#/components/parameters/preferReturn"}],"requestBody":{"$ref":"#/components/requestBodies/body.members"},"responses":{"204":{"description":"No Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column, an invalid filter or an invalid body.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column members.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the members:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.","content":{"application/json":{"example":{"code":"23505","details":"Key (id)=(00000000-0000-0000-0000-000000000000) already exists.","hint":null,"message":"duplicate key value violates unique constraint \"members_pkey\""},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Links users to organizations via roles","tags":["members"],"description":"Requires the `members:write` scope.","security":[{"apiKey":[]},{"oauth2":["members:write"]}],"x-scope":"members:write"},"delete":{"parameters":[{"description":"The identifier of the member to revoke.","in":"query","name":"id","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"The deleted member","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":{"id":"00000000-0000-0000-0000-000000000000","external_id":"example-id","organization_id":"00000000-0000-0000-0000-000000000000","user_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","permissions":["billing","edit_candidates","edit_layouts","settings","team","view_candidates"],"values":{"first_name":"John","last_name":"Doe"}},"schema":{"$ref":"#/components/schemas/members"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the members:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The member doesn't exist in the API key's organization.","content":{"application/json":{"example":{"details":null,"hint":null,"message":"Not found"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Revoke a member","tags":["members"],"description":"Requires the `members:write` scope.","security":[{"apiKey":[]},{"oauth2":["members:write"]}],"x-scope":"members:write"},"post":{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the member to invite."},"language":{"allOf":[{"$ref":"#/components/schemas/Language"}],"default":"en","description":"The language of the member to invite."},"name":{"default":"","description":"The name of the member to invite.","type":"string"},"permissions":{"default":["edit_candidates","edit_layouts","view_candidates"],"description":"The permissions of the member. Defaults to editing candidates and layouts, and viewing candidates.","type":"array","items":{"$ref":"#/components/schemas/Permission"}},"silent":{"default":false,"description":"Whether to skip the invitation email.","type":"boolean"}},"required":["email"]}}},"required":true},"responses":{"201":{"description":"The invited member","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":{"id":"00000000-0000-0000-0000-000000000000","external_id":"example-id","organization_id":"00000000-0000-0000-0000-000000000000","user_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","permissions":["billing","edit_candidates","edit_layouts","settings","team","view_candidates"],"values":{"first_name":"John","last_name":"Doe"}},"schema":{"$ref":"#/components/schemas/members"}}}},"400":{"description":"The body is invalid: not JSON, a required field is missing or a field has the wrong type or value. The details name each invalid field and why.","content":{"application/json":{"example":{"details":"silent: Invalid input","hint":null,"message":"The request body is invalid"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the members:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Invite a member","tags":["members"],"description":"Requires the `members:write` scope.","security":[{"apiKey":[]},{"oauth2":["members:write"]}],"x-scope":"members:write"}},"/organizations":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.organizations.id"},{"$ref":"#/components/parameters/rowFilter.organizations.avatar"},{"$ref":"#/components/parameters/rowFilter.organizations.created_at"},{"$ref":"#/components/parameters/rowFilter.organizations.deleted_at"},{"$ref":"#/components/parameters/rowFilter.organizations.name"},{"$ref":"#/components/parameters/rowFilter.organizations.updated_at"},{"$ref":"#/components/parameters/rowFilter.organizations.fts"},{"$ref":"#/components/parameters/rowFilter.organizations.type"},{"$ref":"#/components/parameters/rowFilter.organizations.slug"},{"$ref":"#/components/parameters/rowFilter.organizations.allowed_senders"},{"$ref":"#/components/parameters/rowFilter.organizations.default_layout_id"},{"$ref":"#/components/parameters/rowFilter.organizations.delete_candidates_after"},{"$ref":"#/components/parameters/rowFilter.organizations.status"},{"$ref":"#/components/parameters/rowFilter.organizations.allow_inspection"},{"$ref":"#/components/parameters/rowFilter.organizations.ats"},{"$ref":"#/components/parameters/rowFilter.organizations.member_variables"},{"$ref":"#/components/parameters/rowFilter.organizations.default_prompt"},{"$ref":"#/components/parameters/rowFilter.organizations.detect_candidate_language_from_attachment"},{"$ref":"#/components/parameters/rowFilter.organizations.proposal_by"},{"$ref":"#/components/parameters/rowFilter.organizations.proposal_reactions"},{"$ref":"#/components/parameters/rowFilter.organizations.model"},{"$ref":"#/components/parameters/rowFilter.organizations.active_ats_integration"},{"$ref":"#/components/parameters/rowFilter.organizations.enable_beta_integrations"},{"$ref":"#/components/parameters/rowFilter.organizations.external_variables"},{"$ref":"#/components/parameters/rowFilter.organizations.allow_word_output"},{"$ref":"#/components/parameters/rowFilter.organizations.billing_account_id"},{"$ref":"#/components/parameters/rowFilter.organizations.require_mfa"},{"$ref":"#/components/parameters/rowFilter.organizations.bullhorn_corporation_id"},{"$ref":"#/components/parameters/rowFilter.organizations.enable_data_tab"},{"$ref":"#/components/parameters/rowFilter.organizations.bullhorn_private_label_id"},{"$ref":"#/components/parameters/rowFilter.organizations.salesforce_instance_url"},{"$ref":"#/components/parameters/rowFilter.organizations.carerix_entity_kind"},{"$ref":"#/components/parameters/rowFilter.organizations.carerix_attachment_node_type"},{"$ref":"#/components/parameters/rowFilter.organizations.seven20_export_make_primary_cv_when_empty"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":"00000000-0000-0000-0000-000000000000","billing_account_id":"00000000-0000-0000-0000-000000000000","bullhorn_corporation_id":"12345","bullhorn_private_label_id":0,"default_layout_id":"00000000-0000-0000-0000-000000000000","mercury_tenant_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","deleted_at":null,"active_ats_integration":"GreenhouseV3","allow_inspection":false,"allow_word_output":false,"allowed_senders":[],"ats":"","avatar":"","carerix_attachment_node_type":"","carerix_entity_kind":"CREmployee","default_prompt":"","delete_candidates_after":0,"detect_candidate_language_from_attachment":false,"enable_beta_integrations":false,"external_variables":[{"ai_instructions":"","sensitive":false,"default":"","key":"name","max_length":null,"min_length":0,"type":"inline-text"},{"ai_instructions":"","sensitive":false,"default":"","key":"description","max_length":null,"min_length":0,"type":"text-block"}],"fts":"'doe':2 'john':1","member_variables":[{"ai_instructions":"","sensitive":false,"default":"","key":"name","max_length":null,"min_length":0,"type":"inline-text"},{"ai_instructions":"","sensitive":false,"default":"","key":"description","max_length":null,"min_length":0,"type":"text-block"}],"mercury_region":"UK","model":"","name":"","proposal_by":"contact","proposal_reactions":[{"id":"invite","body":"","type":"email","subject":""},{"id":"comment","body":"","type":"email","subject":""},{"id":"reject","body":"","type":"email","subject":""}],"require_mfa":false,"salesforce_instance_url":"","seven20_export_make_primary_cv_when_empty":false,"slug":"","status":"active","type":"regular"}],"schema":{"items":{"$ref":"#/components/schemas/organizations"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column organizations.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the organization:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"All base information per organizations","tags":["organizations"],"description":"Requires the `organization:read` scope.","security":[{"apiKey":[]},{"oauth2":["organization:read"]}],"x-scope":"organization:read"},"patch":{"parameters":[{"$ref":"#/components/parameters/rowFilter.organizations.id"},{"$ref":"#/components/parameters/rowFilter.organizations.avatar"},{"$ref":"#/components/parameters/rowFilter.organizations.created_at"},{"$ref":"#/components/parameters/rowFilter.organizations.deleted_at"},{"$ref":"#/components/parameters/rowFilter.organizations.name"},{"$ref":"#/components/parameters/rowFilter.organizations.updated_at"},{"$ref":"#/components/parameters/rowFilter.organizations.fts"},{"$ref":"#/components/parameters/rowFilter.organizations.type"},{"$ref":"#/components/parameters/rowFilter.organizations.slug"},{"$ref":"#/components/parameters/rowFilter.organizations.allowed_senders"},{"$ref":"#/components/parameters/rowFilter.organizations.default_layout_id"},{"$ref":"#/components/parameters/rowFilter.organizations.delete_candidates_after"},{"$ref":"#/components/parameters/rowFilter.organizations.status"},{"$ref":"#/components/parameters/rowFilter.organizations.allow_inspection"},{"$ref":"#/components/parameters/rowFilter.organizations.ats"},{"$ref":"#/components/parameters/rowFilter.organizations.member_variables"},{"$ref":"#/components/parameters/rowFilter.organizations.default_prompt"},{"$ref":"#/components/parameters/rowFilter.organizations.detect_candidate_language_from_attachment"},{"$ref":"#/components/parameters/rowFilter.organizations.proposal_by"},{"$ref":"#/components/parameters/rowFilter.organizations.proposal_reactions"},{"$ref":"#/components/parameters/rowFilter.organizations.model"},{"$ref":"#/components/parameters/rowFilter.organizations.active_ats_integration"},{"$ref":"#/components/parameters/rowFilter.organizations.enable_beta_integrations"},{"$ref":"#/components/parameters/rowFilter.organizations.external_variables"},{"$ref":"#/components/parameters/rowFilter.organizations.allow_word_output"},{"$ref":"#/components/parameters/rowFilter.organizations.billing_account_id"},{"$ref":"#/components/parameters/rowFilter.organizations.require_mfa"},{"$ref":"#/components/parameters/rowFilter.organizations.bullhorn_corporation_id"},{"$ref":"#/components/parameters/rowFilter.organizations.enable_data_tab"},{"$ref":"#/components/parameters/rowFilter.organizations.bullhorn_private_label_id"},{"$ref":"#/components/parameters/rowFilter.organizations.salesforce_instance_url"},{"$ref":"#/components/parameters/rowFilter.organizations.carerix_entity_kind"},{"$ref":"#/components/parameters/rowFilter.organizations.carerix_attachment_node_type"},{"$ref":"#/components/parameters/rowFilter.organizations.seven20_export_make_primary_cv_when_empty"},{"$ref":"#/components/parameters/preferReturn"}],"requestBody":{"$ref":"#/components/requestBodies/body.organizations"},"responses":{"204":{"description":"No Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column, an invalid filter or an invalid body.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column organizations.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the organization:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.","content":{"application/json":{"example":{"code":"23505","details":"Key (id)=(00000000-0000-0000-0000-000000000000) already exists.","hint":null,"message":"duplicate key value violates unique constraint \"organizations_pkey\""},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"All base information per organizations","tags":["organizations"],"description":"Requires the `organization:write` scope.","security":[{"apiKey":[]},{"oauth2":["organization:write"]}],"x-scope":"organization:write"}},"/user_profiles":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.user_profiles.user_id"},{"$ref":"#/components/parameters/rowFilter.user_profiles.avatar"},{"$ref":"#/components/parameters/rowFilter.user_profiles.created_at"},{"$ref":"#/components/parameters/rowFilter.user_profiles.email"},{"$ref":"#/components/parameters/rowFilter.user_profiles.language"},{"$ref":"#/components/parameters/rowFilter.user_profiles.last_login_at"},{"$ref":"#/components/parameters/rowFilter.user_profiles.name"},{"$ref":"#/components/parameters/rowFilter.user_profiles.source"},{"$ref":"#/components/parameters/rowFilter.user_profiles.updated_at"},{"$ref":"#/components/parameters/rowFilter.user_profiles.phone"},{"$ref":"#/components/parameters/rowFilter.user_profiles.invited_at"},{"$ref":"#/components/parameters/rowFilter.user_profiles.fts"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"user_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","avatar":"","email":"","fts":"'doe':2 'john':1","invited_at":null,"language":"en","last_login_at":null,"name":"","phone":"","source":""}],"schema":{"items":{"$ref":"#/components/schemas/user_profiles"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column user_profiles.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the members:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"tags":["user_profiles"],"description":"Requires the `members:read` scope.","security":[{"apiKey":[]},{"oauth2":["members:read"]}],"x-scope":"members:read"}},"/webhook_notifications":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.webhook_notifications.id"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.webhook_id"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.created_at"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.updated_at"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.event_type"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.payload"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.status"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.response"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.tries"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.created_on"},{"$ref":"#/components/parameters/rowFilter.webhook_notifications.next_attempt_at"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":"00000000-0000-0000-0000-000000000000","webhook_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","created_on":"2026-01-01","event_type":"candidates.created","next_attempt_at":"2026-01-01T12:00:00+00:00","payload":{},"response":"","status":"sent","tries":0}],"schema":{"items":{"$ref":"#/components/schemas/webhook_notifications"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column webhook_notifications.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the webhooks:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Tracks notifications sent via webhooks for various events","tags":["webhook_notifications"],"description":"Requires the `webhooks:read` scope.","security":[{"apiKey":[]},{"oauth2":["webhooks:read"]}],"x-scope":"webhooks:read"}},"/webhooks":{"get":{"parameters":[{"$ref":"#/components/parameters/rowFilter.webhooks.id"},{"$ref":"#/components/parameters/rowFilter.webhooks.created_at"},{"$ref":"#/components/parameters/rowFilter.webhooks.updated_at"},{"$ref":"#/components/parameters/rowFilter.webhooks.endpoint"},{"$ref":"#/components/parameters/rowFilter.webhooks.description"},{"$ref":"#/components/parameters/rowFilter.webhooks.organization_id"},{"$ref":"#/components/parameters/rowFilter.webhooks.events"},{"$ref":"#/components/parameters/rowFilter.webhooks.signing_secret"},{"$ref":"#/components/parameters/rowFilter.webhooks.source"},{"$ref":"#/components/parameters/rowFilter.webhooks.disabled_at"},{"$ref":"#/components/parameters/rowFilter.webhooks.grant_id"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/range"},{"$ref":"#/components/parameters/rangeUnit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/preferCount"}],"responses":{"200":{"description":"OK","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"example":[{"id":"00000000-0000-0000-0000-000000000000","grant_id":"00000000-0000-0000-0000-000000000000","organization_id":"00000000-0000-0000-0000-000000000000","created_at":"2026-01-01T12:00:00+00:00","updated_at":"2026-01-01T12:00:00+00:00","description":"","disabled_at":null,"endpoint":"","events":["candidates.created","members.updated"],"signing_secret":"","source":""}],"schema":{"items":{"$ref":"#/components/schemas/webhooks"},"type":"array"}}}},"206":{"description":"Partial Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column webhooks.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs.","content":{"application/json":{"example":{"details":"This request needs the webhooks:read scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Webhook event destinations","tags":["webhooks"],"description":"Requires the `webhooks:read` scope.","security":[{"apiKey":[]},{"oauth2":["webhooks:read"]}],"x-scope":"webhooks:read"},"post":{"parameters":[{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/preferPost"}],"requestBody":{"$ref":"#/components/requestBodies/body.webhooks"},"responses":{"201":{"description":"Created","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column, an invalid filter or an invalid body.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column webhooks.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the webhooks:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.","content":{"application/json":{"example":{"code":"23505","details":"Key (id)=(00000000-0000-0000-0000-000000000000) already exists.","hint":null,"message":"duplicate key value violates unique constraint \"webhooks_pkey\""},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Webhook event destinations","tags":["webhooks"],"description":"Requires the `webhooks:write` scope.","security":[{"apiKey":[]},{"oauth2":["webhooks:write"]}],"x-scope":"webhooks:write"},"delete":{"parameters":[{"$ref":"#/components/parameters/rowFilter.webhooks.id"},{"$ref":"#/components/parameters/rowFilter.webhooks.created_at"},{"$ref":"#/components/parameters/rowFilter.webhooks.updated_at"},{"$ref":"#/components/parameters/rowFilter.webhooks.endpoint"},{"$ref":"#/components/parameters/rowFilter.webhooks.description"},{"$ref":"#/components/parameters/rowFilter.webhooks.organization_id"},{"$ref":"#/components/parameters/rowFilter.webhooks.events"},{"$ref":"#/components/parameters/rowFilter.webhooks.signing_secret"},{"$ref":"#/components/parameters/rowFilter.webhooks.source"},{"$ref":"#/components/parameters/rowFilter.webhooks.disabled_at"},{"$ref":"#/components/parameters/rowFilter.webhooks.grant_id"},{"$ref":"#/components/parameters/preferReturn"}],"responses":{"204":{"description":"No Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column or an invalid filter.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column webhooks.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the webhooks:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Webhook event destinations","tags":["webhooks"],"description":"Requires the `webhooks:write` scope.","security":[{"apiKey":[]},{"oauth2":["webhooks:write"]}],"x-scope":"webhooks:write"},"patch":{"parameters":[{"$ref":"#/components/parameters/rowFilter.webhooks.id"},{"$ref":"#/components/parameters/rowFilter.webhooks.created_at"},{"$ref":"#/components/parameters/rowFilter.webhooks.updated_at"},{"$ref":"#/components/parameters/rowFilter.webhooks.endpoint"},{"$ref":"#/components/parameters/rowFilter.webhooks.description"},{"$ref":"#/components/parameters/rowFilter.webhooks.organization_id"},{"$ref":"#/components/parameters/rowFilter.webhooks.events"},{"$ref":"#/components/parameters/rowFilter.webhooks.signing_secret"},{"$ref":"#/components/parameters/rowFilter.webhooks.source"},{"$ref":"#/components/parameters/rowFilter.webhooks.disabled_at"},{"$ref":"#/components/parameters/rowFilter.webhooks.grant_id"},{"$ref":"#/components/parameters/preferReturn"}],"requestBody":{"$ref":"#/components/requestBodies/body.webhooks"},"responses":{"204":{"description":"No Content","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"The request is malformed, for example an unknown column, an invalid filter or an invalid body.","content":{"application/json":{"example":{"code":"42703","details":null,"hint":null,"message":"column webhooks.nmae does not exist"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or invalid.","content":{"application/json":{"example":{"details":null,"hint":"Send an API key or OAuth access token as a Bearer token in the Authorization header","message":"Unauthorized"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key doesn't have the scope this request needs, or no permission for this change, for example when writing rows of another organization.","content":{"application/json":{"example":{"details":"This request needs the webhooks:write scope","hint":"Change the scopes of the API key in the organization's settings, or connect the app again with more access","message":"The API key doesn't give access to this resource"},"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.","content":{"application/json":{"example":{"code":"23505","details":"Key (id)=(00000000-0000-0000-0000-000000000000) already exists.","hint":null,"message":"duplicate key value violates unique constraint \"webhooks_pkey\""},"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.","content":{"application/json":{"example":{"details":"This API key may make 120 requests per minute. Retry after 12 seconds.","hint":"Wait for the time in the Retry-After header, or request a higher limit from support@cv-transformer.com","message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"summary":"Webhook event destinations","tags":["webhooks"],"description":"Requires the `webhooks:write` scope.","security":[{"apiKey":[]},{"oauth2":["webhooks:write"]}],"x-scope":"webhooks:write"}}},"components":{"headers":{"RateLimit":{"description":"The requests the API key has left in the current window, and the seconds until it resets, like `\"default\";r=118;t=42`","schema":{"type":"string"}},"RateLimit-Policy":{"description":"The API key's rate limit, like `\"default\";q=120;w=60`: requests per window of seconds","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before the next request fits","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests per minute the API key may make","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests the API key has left in the current minute","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the rate limit resets","schema":{"type":"integer"}}},"parameters":{"preferReturn":{"description":"Preference","in":"header","name":"Prefer","required":false,"schema":{"enum":["return=representation","return=minimal","return=none"],"type":"string"}},"preferCount":{"description":"Preference","in":"header","name":"Prefer","required":false,"schema":{"enum":["count=none"],"type":"string"}},"preferPost":{"description":"Preference","in":"header","name":"Prefer","required":false,"schema":{"enum":["return=representation","return=minimal","return=none","resolution=ignore-duplicates","resolution=merge-duplicates"],"type":"string"}},"select":{"description":"Filtering Columns","in":"query","name":"select","required":false,"schema":{"type":"string"}},"order":{"description":"Ordering","in":"query","name":"order","required":false,"schema":{"type":"string"}},"range":{"description":"Limiting and Pagination","in":"header","name":"Range","required":false,"schema":{"type":"string"}},"rangeUnit":{"description":"Limiting and Pagination","in":"header","name":"Range-Unit","required":false,"schema":{"default":"items","type":"string"}},"offset":{"description":"Limiting and Pagination","in":"query","name":"offset","required":false,"schema":{"type":"string"}},"limit":{"description":"Limiting and Pagination","in":"query","name":"limit","required":false,"schema":{"type":"string"}},"rowFilter.candidate_views.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.candidate_views.candidate_id":{"description":"Identifier of the related candidate","in":"query","name":"candidate_id","required":false,"schema":{"type":"string"}},"rowFilter.candidate_views.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.candidate_views.anonymous":{"description":"Whether the candidate was viewed with personal information redacted or not","in":"query","name":"anonymous","required":false,"schema":{"type":"string"}},"rowFilter.candidate_analytics.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.candidate_analytics.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.candidate_analytics.updated_at":{"description":"Last update timestamp","in":"query","name":"updated_at","required":false,"schema":{"type":"string"}},"rowFilter.candidate_analytics.candidate_id":{"description":"Identifier of the related candidate","in":"query","name":"candidate_id","required":false,"schema":{"type":"string"}},"rowFilter.candidate_analytics.organization_id":{"description":"Identifier of the related organization","in":"query","name":"organization_id","required":false,"schema":{"type":"string"}},"rowFilter.candidate_analytics.time_spent":{"description":"Time spent in seconds","in":"query","name":"time_spent","required":false,"schema":{"type":"string"}},"rowFilter.api_requests.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.api_requests.api_key_id":{"description":"Identifier of the API key used for the request. Either this or grant_id is set","in":"query","name":"api_key_id","required":false,"schema":{"type":"string"}},"rowFilter.api_requests.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.api_requests.endpoint":{"description":"API endpoint that was called","in":"query","name":"endpoint","required":false,"schema":{"type":"string"}},"rowFilter.api_requests.method":{"description":"Request method","in":"query","name":"method","required":false,"schema":{"type":"string"}},"rowFilter.api_requests.created_on":{"description":"Date on which the API key was used","in":"query","name":"created_on","required":false,"schema":{"type":"string"}},"rowFilter.api_requests.search":{"description":"Search params passed to the API request","in":"query","name":"search","required":false,"schema":{"type":"string"}},"rowFilter.api_requests.status":{"description":"Resulting HTTP status code","in":"query","name":"status","required":false,"schema":{"type":"string"}},"rowFilter.api_requests.grant_id":{"description":"Identifier of the OAuth grant whose token made the request. Either this or api_key_id is set","in":"query","name":"grant_id","required":false,"schema":{"type":"string"}},"rowFilter.credit_mutations.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.credit_mutations.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.credit_mutations.organization_id":{"description":"Identifier of the organization related to this mutation","in":"query","name":"organization_id","required":false,"schema":{"type":"string"}},"rowFilter.credit_mutations.delta":{"description":"Difference between next and previous credit","in":"query","name":"delta","required":false,"schema":{"type":"string"}},"rowFilter.credit_mutations.billing_account_id":{"description":"Identifier of the related billing account","in":"query","name":"billing_account_id","required":false,"schema":{"type":"string"}},"rowFilter.credit_mutations.paddle_transaction_id":{"description":"Paddle transaction that bought the credit, if any","in":"query","name":"paddle_transaction_id","required":false,"schema":{"type":"string"}},"rowFilter.candidates.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.candidates.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.candidates.organization_id":{"description":"Identifier of the related organization","in":"query","name":"organization_id","required":false,"schema":{"type":"string"}},"rowFilter.candidates.updated_at":{"description":"Last modification timestamp","in":"query","name":"updated_at","required":false,"schema":{"type":"string"}},"rowFilter.candidates.status":{"description":"Status of the candidate. Only `active` candidates can be shared","in":"query","name":"status","required":false,"schema":{"type":"string"}},"rowFilter.candidates.secret":{"description":"Secret string. Used to privately share a proposal for this candidate with personal information non-redacted","in":"query","name":"secret","required":false,"schema":{"type":"string"}},"rowFilter.candidates.secret_anonymous":{"description":"Secret string. Used to privately share a proposal for this candidate with personal information redacted","in":"query","name":"secret_anonymous","required":false,"schema":{"type":"string"}},"rowFilter.candidates.layout_id":{"description":"Identifier of the related layout","in":"query","name":"layout_id","required":false,"schema":{"type":"string"}},"rowFilter.candidates.values":{"description":"Values for the each of the variables defined in the layout the candidate uses","in":"query","name":"values","required":false,"schema":{"type":"string"}},"rowFilter.candidates.language":{"description":"Language this candidate should be displayed in","in":"query","name":"language","required":false,"schema":{"type":"string"}},"rowFilter.candidates.member_id":{"description":"Identifier of the member associated with this candidate (initially the creator)","in":"query","name":"member_id","required":false,"schema":{"type":"string"}},"rowFilter.candidates.attachments":{"description":"Files attached to this candidate (CV, Vacancy, other)","in":"query","name":"attachments","required":false,"schema":{"type":"string"}},"rowFilter.candidates.name":{"description":"The candidate's name. Used for searching. Automatically filled when editing candidate from UI","in":"query","name":"name","required":false,"schema":{"type":"string"}},"rowFilter.candidates.avatar":{"description":"The candidate's avatar image. Used for efficient display. Automatically filled when editing candidate from UI","in":"query","name":"avatar","required":false,"schema":{"type":"string"}},"rowFilter.candidates.secret_editable":{"description":"Secret string. Used to share the candidate for editing.","in":"query","name":"secret_editable","required":false,"schema":{"type":"string"}},"rowFilter.candidates.deleted_at":{"description":"Deletion timestamp","in":"query","name":"deleted_at","required":false,"schema":{"type":"string"}},"rowFilter.candidates.export_filename":{"description":"Filename for exported PDF file (without .pdf). If left empty, layout.export_filename applies.","in":"query","name":"export_filename","required":false,"schema":{"type":"string"}},"rowFilter.candidates.external_data":{"description":"Data imported from an external source","in":"query","name":"external_data","required":false,"schema":{"type":"string"}},"rowFilter.candidates.messages":{"description":"List of messages exchanged with AI","in":"query","name":"messages","required":false,"schema":{"type":"string"}},"rowFilter.candidates.section_attachments":{"description":"Links of attachments per attachment section","in":"query","name":"section_attachments","required":false,"schema":{"type":"string"}},"rowFilter.candidates.fts":{"in":"query","name":"fts","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.webhook_id":{"description":"Identifier of the webhook this notification is related to","in":"query","name":"webhook_id","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.updated_at":{"description":"Last modification timestamp","in":"query","name":"updated_at","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.event_type":{"description":"Event this notification is for","in":"query","name":"event_type","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.payload":{"description":"JSON payload that is sent along with this notification: the object before (`old`, null for `.created` events) and after (`new`) the change. Member events add the user's `name` and `email` to both under `user_profiles`","in":"query","name":"payload","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.status":{"description":"Notification status","in":"query","name":"status","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.response":{"description":"Stored response","in":"query","name":"response","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.tries":{"description":"Amount of times this webhook notification has been tried to be delivered","in":"query","name":"tries","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.created_on":{"description":"Date on which the notification was created","in":"query","name":"created_on","required":false,"schema":{"type":"string"}},"rowFilter.webhook_notifications.next_attempt_at":{"description":"When the next delivery attempt is due, or the end of the claim of the attempt in progress","in":"query","name":"next_attempt_at","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.user_id":{"description":"Unique identifier","in":"query","name":"user_id","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.avatar":{"description":"Avatar image url","in":"query","name":"avatar","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.email":{"description":"Email address","in":"query","name":"email","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.language":{"description":"User language","in":"query","name":"language","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.last_login_at":{"description":"Last login timestamp","in":"query","name":"last_login_at","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.name":{"description":"User name","in":"query","name":"name","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.source":{"description":"User source","in":"query","name":"source","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.updated_at":{"description":"Last modification timestamp","in":"query","name":"updated_at","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.phone":{"description":"User phone number","in":"query","name":"phone","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.invited_at":{"description":"Last invite timestamp","in":"query","name":"invited_at","required":false,"schema":{"type":"string"}},"rowFilter.user_profiles.fts":{"in":"query","name":"fts","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.updated_at":{"description":"Last modification timestamp","in":"query","name":"updated_at","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.endpoint":{"description":"URL to which notifications should be sent","in":"query","name":"endpoint","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.description":{"description":"An optional description of the webhook","in":"query","name":"description","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.organization_id":{"description":"Identifier of the organization this webhook is defined in","in":"query","name":"organization_id","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.events":{"description":"Events to which the webhook is subscribed","in":"query","name":"events","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.signing_secret":{"description":"Secret used to sign each notification sent to the webhook. Verify notifications with the Standard Webhooks headers (webhook-id, webhook-timestamp, webhook-signature: HMAC-SHA256 with this secret as key). The X-Signature header (MD5) is deprecated and will be removed in the future","in":"query","name":"signing_secret","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.source":{"description":"From where the webhook is registered. Can be from the admin, via the API, or via an external tool such as Zapier","in":"query","name":"source","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.disabled_at":{"description":"When the webhook was disabled, because its endpoint kept failing or the OAuth grant that created it lost access. A disabled webhook gets no notifications; set this to null to enable it again","in":"query","name":"disabled_at","required":false,"schema":{"type":"string"}},"rowFilter.webhooks.grant_id":{"description":"Identifier of the OAuth grant that created the webhook. Revoking the grant, or its access to the organization, disables the webhook","in":"query","name":"grant_id","required":false,"schema":{"type":"string"}},"rowFilter.organizations.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.organizations.avatar":{"description":"Avatar image representing the organization","in":"query","name":"avatar","required":false,"schema":{"type":"string"}},"rowFilter.organizations.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.organizations.deleted_at":{"description":"Deletion timestamp","in":"query","name":"deleted_at","required":false,"schema":{"type":"string"}},"rowFilter.organizations.name":{"description":"Name of the organization","in":"query","name":"name","required":false,"schema":{"type":"string"}},"rowFilter.organizations.updated_at":{"description":"Last modification timestamp","in":"query","name":"updated_at","required":false,"schema":{"type":"string"}},"rowFilter.organizations.fts":{"in":"query","name":"fts","required":false,"schema":{"type":"string"}},"rowFilter.organizations.type":{"description":"Type of the organization","in":"query","name":"type","required":false,"schema":{"type":"string"}},"rowFilter.organizations.slug":{"description":"Unique string. Organization has a candidate email inbox at `{{slug}}@candidates.cv-transformer.com`","in":"query","name":"slug","required":false,"schema":{"type":"string"}},"rowFilter.organizations.allowed_senders":{"description":"List of email addresses that are allowed to send CV's to the organizations inbox. Email addresses can be partial (e.g., *@example.com)","in":"query","name":"allowed_senders","required":false,"schema":{"type":"string"}},"rowFilter.organizations.default_layout_id":{"description":"Identifier of the layout that is used for new candidates by default","in":"query","name":"default_layout_id","required":false,"schema":{"type":"string"}},"rowFilter.organizations.delete_candidates_after":{"description":"Time in days after which candidates are automatically deleted","in":"query","name":"delete_candidates_after","required":false,"schema":{"type":"string"}},"rowFilter.organizations.status":{"description":"Internal status for the organization","in":"query","name":"status","required":false,"schema":{"type":"string"}},"rowFilter.organizations.allow_inspection":{"description":"Whether the CV-Transformer team is allowed to inspect the organization to debug errors","in":"query","name":"allow_inspection","required":false,"schema":{"type":"string"}},"rowFilter.organizations.ats":{"description":"The ATS this organization uses","in":"query","name":"ats","required":false,"schema":{"type":"string"}},"rowFilter.organizations.member_variables":{"description":"Metafields defined on each member. Usable in layouts","in":"query","name":"member_variables","required":false,"schema":{"type":"string"}},"rowFilter.organizations.default_prompt":{"description":"Default prompt used when filling in candidate data","in":"query","name":"default_prompt","required":false,"schema":{"type":"string"}},"rowFilter.organizations.detect_candidate_language_from_attachment":{"description":"Automatically detect candidate language when first attachment is uploaded.","in":"query","name":"detect_candidate_language_from_attachment","required":false,"schema":{"type":"string"}},"rowFilter.organizations.proposal_by":{"description":"Author shown on weblink proposals","in":"query","name":"proposal_by","required":false,"schema":{"type":"string"}},"rowFilter.organizations.proposal_reactions":{"description":"Allowed reactions on proposals","in":"query","name":"proposal_reactions","required":false,"schema":{"type":"string"}},"rowFilter.organizations.model":{"description":"LLM model to use","in":"query","name":"model","required":false,"schema":{"type":"string"}},"rowFilter.organizations.active_ats_integration":{"description":"Currently active ATS integration","in":"query","name":"active_ats_integration","required":false,"schema":{"type":"string"}},"rowFilter.organizations.enable_beta_integrations":{"in":"query","name":"enable_beta_integrations","required":false,"schema":{"type":"string"}},"rowFilter.organizations.external_variables":{"description":"Schema for data imported from external integration","in":"query","name":"external_variables","required":false,"schema":{"type":"string"}},"rowFilter.organizations.allow_word_output":{"description":"Whether Word-output is enabled for the organization","in":"query","name":"allow_word_output","required":false,"schema":{"type":"string"}},"rowFilter.organizations.billing_account_id":{"description":"Identifier of the billing account this organization belongs to","in":"query","name":"billing_account_id","required":false,"schema":{"type":"string"}},"rowFilter.organizations.require_mfa":{"description":"Whether MFA is required for members to access this organization","in":"query","name":"require_mfa","required":false,"schema":{"type":"string"}},"rowFilter.organizations.bullhorn_corporation_id":{"in":"query","name":"bullhorn_corporation_id","required":false,"schema":{"type":"string"}},"rowFilter.organizations.enable_data_tab":{"in":"query","name":"enable_data_tab","required":false,"schema":{"type":"string"}},"rowFilter.organizations.bullhorn_private_label_id":{"in":"query","name":"bullhorn_private_label_id","required":false,"schema":{"type":"string"}},"rowFilter.organizations.salesforce_instance_url":{"in":"query","name":"salesforce_instance_url","required":false,"schema":{"type":"string"}},"rowFilter.organizations.carerix_entity_kind":{"in":"query","name":"carerix_entity_kind","required":false,"schema":{"type":"string"}},"rowFilter.organizations.carerix_attachment_node_type":{"in":"query","name":"carerix_attachment_node_type","required":false,"schema":{"type":"string"}},"rowFilter.organizations.seven20_export_make_primary_cv_when_empty":{"in":"query","name":"seven20_export_make_primary_cv_when_empty","required":false,"schema":{"type":"string"}},"rowFilter.layouts.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.layouts.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.layouts.creator_id":{"description":"Identifier of the user that created this layout. Set automatically: the signed-in user, or the user who connected the OAuth app. Null for layouts created with an API key","in":"query","name":"creator_id","required":false,"schema":{"type":"string"}},"rowFilter.layouts.organization_id":{"description":"Identifier of the related organization","in":"query","name":"organization_id","required":false,"schema":{"type":"string"}},"rowFilter.layouts.updated_at":{"description":"Last modification timestamp","in":"query","name":"updated_at","required":false,"schema":{"type":"string"}},"rowFilter.layouts.name":{"description":"Title of this layout","in":"query","name":"name","required":false,"schema":{"type":"string"}},"rowFilter.layouts.fts":{"in":"query","name":"fts","required":false,"schema":{"type":"string"}},"rowFilter.layouts.thumbnail":{"description":"Thumbnail image for this layout. Automatically generated","in":"query","name":"thumbnail","required":false,"schema":{"type":"string"}},"rowFilter.layouts.visibility":{"description":"Visibility of this layout. \"public\" means the layout is published to the layout library.","in":"query","name":"visibility","required":false,"schema":{"type":"string"}},"rowFilter.layouts.secret":{"description":"Secret string. Required to view the layout when its visibility is \"private\"","in":"query","name":"secret","required":false,"schema":{"type":"string"}},"rowFilter.layouts.parent_id":{"description":"Identifier of the layout this layout originates from","in":"query","name":"parent_id","required":false,"schema":{"type":"string"}},"rowFilter.layouts.tokens":{"description":"List of design tokens used in the layout","in":"query","name":"tokens","required":false,"schema":{"type":"string"}},"rowFilter.layouts.sections":{"description":"List of sections the layout consists of","in":"query","name":"sections","required":false,"schema":{"type":"string"}},"rowFilter.layouts.featured":{"description":"Whether the layout is featured in the layout library","in":"query","name":"featured","required":false,"schema":{"type":"string"}},"rowFilter.layouts.slug":{"description":"Unique identifier that allows easy lookup in the layout library","in":"query","name":"slug","required":false,"schema":{"type":"string"}},"rowFilter.layouts.variables":{"description":"List of variables used in the layout. Each `candidate` using this `layout` populates these variables","in":"query","name":"variables","required":false,"schema":{"type":"string"}},"rowFilter.layouts.default_values":{"description":"Default values for each of the variables in the layout. When left empty, these values are auto-generated","in":"query","name":"default_values","required":false,"schema":{"type":"string"}},"rowFilter.layouts.languages":{"description":"Languages the layout is translated in. First entry indicates the default language","in":"query","name":"languages","required":false,"schema":{"type":"string"}},"rowFilter.layouts.assets":{"description":"Reusable assets used in the layout","in":"query","name":"assets","required":false,"schema":{"type":"string"}},"rowFilter.layouts.export_filename":{"description":"Filename for exported PDF files (without .pdf). Can contain {{variables}}","in":"query","name":"export_filename","required":false,"schema":{"type":"string"}},"rowFilter.layouts.share_instructions":{"description":"Optional instructions shown in the share modal","in":"query","name":"share_instructions","required":false,"schema":{"type":"string"}},"rowFilter.layouts.web_settings":{"description":"Additional layout settings for web sharing","in":"query","name":"web_settings","required":false,"schema":{"type":"string"}},"rowFilter.layouts.archived_at":{"description":"Timestamp at which the layout is archived","in":"query","name":"archived_at","required":false,"schema":{"type":"string"}},"rowFilter.layouts.description":{"description":"SEO description of the layout for in the library","in":"query","name":"description","required":false,"schema":{"type":"string"}},"rowFilter.layouts.page_height":{"description":"Page height (in pixels)","in":"query","name":"page_height","required":false,"schema":{"type":"string"}},"rowFilter.layouts.page_width":{"description":"Page width (in pixels)","in":"query","name":"page_width","required":false,"schema":{"type":"string"}},"rowFilter.layouts.custom_css":{"description":"Custom CSS for the layout","in":"query","name":"custom_css","required":false,"schema":{"type":"string"}},"rowFilter.members.organization_id":{"description":"Identifier of the related organization","in":"query","name":"organization_id","required":false,"schema":{"type":"string"}},"rowFilter.members.user_id":{"description":"Identifier of the related user","in":"query","name":"user_id","required":false,"schema":{"type":"string"}},"rowFilter.members.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.members.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.members.updated_at":{"description":"Last modification timestamp","in":"query","name":"updated_at","required":false,"schema":{"type":"string"}},"rowFilter.members.values":{"description":"Values for each of the organization's `member_variables`, usable in layouts","in":"query","name":"values","required":false,"schema":{"type":"string"}},"rowFilter.members.permissions":{"description":"The permissions this member has","in":"query","name":"permissions","required":false,"schema":{"type":"string"}},"rowFilter.members.external_id":{"description":"The ID of this member in an external system. Used for matching imported candidates.","in":"query","name":"external_id","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.id":{"description":"Unique identifier","in":"query","name":"id","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.created_at":{"description":"Creation timestamp","in":"query","name":"created_at","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.updated_at":{"description":"Last modification timestamp","in":"query","name":"updated_at","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.credit":{"description":"Amount of credits currently available","in":"query","name":"credit","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.currency":{"description":"Currency in which the organization is billed","in":"query","name":"currency","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.minimum_guarantee":{"description":"Minimum billed usage per month","in":"query","name":"minimum_guarantee","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.next_billed_at":{"description":"Next billing timestamp","in":"query","name":"next_billed_at","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.paddle_subscription_id":{"description":"Identifier of the subscription in Paddle","in":"query","name":"paddle_subscription_id","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.prev_usage":{"description":"Number of credits used in previous 7 days","in":"query","name":"prev_usage","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.price_per_credit":{"description":"Agreed price per credit","in":"query","name":"price_per_credit","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.pricing_version":{"description":"The organization's pricing version","in":"query","name":"pricing_version","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.recent_usage":{"description":"Number of credits used in the last 7 days","in":"query","name":"recent_usage","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.subscription_type":{"description":"Active subscription type ","in":"query","name":"subscription_type","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.trial_expires_at":{"description":"Trial expiration timestamp","in":"query","name":"trial_expires_at","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.user_licenses":{"description":"Max number of users with edit_candidates permission in this billing account. Only limits subscriptions.","in":"query","name":"user_licenses","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.price_per_user":{"description":"Agreed price per user license","in":"query","name":"price_per_user","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.maximum_usage":{"in":"query","name":"maximum_usage","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.allow_pre_paid":{"in":"query","name":"allow_pre_paid","required":false,"schema":{"type":"string"}},"rowFilter.billing_accounts.overage_billed_for":{"description":"The next_billed_at whose overage bill-overage settled, so it is charged once per period","in":"query","name":"overage_billed_for","required":false,"schema":{"type":"string"}}},"requestBodies":{"body.candidates":{"description":"candidates","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/candidates"}}}},"body.webhooks":{"description":"webhooks","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"}}}},"body.organizations":{"description":"organizations","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations"}}}},"body.layouts":{"description":"layouts","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/layouts"}}}},"body.members":{"description":"members","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/members"}}}},"body.billing_accounts":{"description":"billing_accounts","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_accounts"}}}}},"schemas":{"api_requests":{"required":["id","created_at","endpoint","method","created_on","search","status"],"properties":{"id":{"format":"integer","type":"integer","readOnly":true,"description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"api_key_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the API key that made the request. Either this or `grant_id` is set\n\nNote:\nThis is a Foreign Key to `api_keys.id`.<fk table='api_keys' column='id'/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"endpoint":{"format":"text","type":"string","readOnly":true,"description":"API endpoint that was called"},"method":{"format":"text","type":"string","readOnly":true,"description":"HTTP method of the request"},"created_on":{"default":"CURRENT_DATE","format":"date","type":"string","readOnly":true,"description":"Date on which the request was made"},"search":{"format":"text","type":"string","readOnly":true,"description":"Query string of the request"},"status":{"format":"smallint","type":"integer","readOnly":true,"description":"HTTP status code of the response"},"grant_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the OAuth grant whose token made the request. Either this or `api_key_id` is set\n\nNote:\nThis is a Foreign Key to `oauth_grants.id`.<fk table='oauth_grants' column='id'/>"}},"type":"object","description":"Requests made to the API, with an API key or an OAuth grant's token"},"billing_accounts":{"required":["id","created_at","updated_at","credit","currency","minimum_guarantee","prev_usage","price_per_credit","pricing_version","recent_usage","subscription_type","price_per_user","maximum_usage","allow_pre_paid"],"properties":{"id":{"default":"extensions.uuid_generate_v4()","format":"uuid","type":"string","readOnly":true,"description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"updated_at":{"default":"now()","format":"timestamp with time zone","type":"string","description":"Last modification timestamp"},"credit":{"default":0,"format":"integer","type":"integer","readOnly":true,"description":"Number of credits currently available"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"Currency in which the billing account is billed"},"minimum_guarantee":{"default":0,"format":"integer","type":"integer","readOnly":true,"description":"Minimum number of credits billed per month"},"next_billed_at":{"description":"Next billing timestamp","format":"timestamp with time zone","type":"string","readOnly":true},"paddle_subscription_id":{"format":"text","type":"string","readOnly":true,"description":"Identifier of the subscription in Paddle"},"prev_usage":{"default":0,"format":"integer","type":"integer","readOnly":true,"description":"Number of credits used in the 7 days before the last 7 days"},"price_per_credit":{"default":150,"format":"integer","type":"integer","readOnly":true,"description":"Agreed price per credit"},"pricing_version":{"allOf":[{"$ref":"#/components/schemas/PricingVersion"}],"description":"Pricing version of the billing account","readOnly":true},"recent_usage":{"default":0,"format":"integer","type":"integer","readOnly":true,"description":"Number of credits used in the last 7 days"},"subscription_type":{"allOf":[{"$ref":"#/components/schemas/SubscriptionType"}],"description":"Type of the active subscription","readOnly":true},"trial_expires_at":{"format":"timestamp with time zone","type":"string","readOnly":true,"description":"Trial expiration timestamp"},"user_licenses":{"format":"integer","type":"integer","readOnly":true,"description":"Maximum number of users with the `edit_candidates` permission in the billing account. Only limits subscriptions; null means no limit"},"price_per_user":{"default":1000,"format":"integer","type":"integer","readOnly":true,"description":"Agreed price per user license"},"maximum_usage":{"default":100000,"format":"integer","type":"integer","readOnly":true,"description":"Number of credits a subscription can use beyond its credit. `credit` goes down to minus this number"},"allow_pre_paid":{"default":false,"format":"boolean","type":"boolean","readOnly":true,"description":"Whether the billing account can buy credits up front, for a pre-paid subscription"},"overage_billed_for":{"format":"timestamp with time zone","type":"string","readOnly":true,"description":"Renewal date, read from Paddle, of the last period whose overage was billed, so overage is charged once per period"}},"type":"object","description":"Billing settings and credit, shared by the organizations that belong to the billing account"},"candidate_analytics":{"required":["id","created_at","updated_at","time_spent"],"properties":{"id":{"default":"extensions.uuid_generate_v4()","format":"uuid","type":"string","readOnly":true,"description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"updated_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Last modification timestamp"},"candidate_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the related candidate\n\nNote:\nThis is a Foreign Key to `candidates.id`.<fk table='candidates' column='id'/>"},"organization_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the related organization\n\nNote:\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>"},"time_spent":{"default":0,"format":"real","type":"number","readOnly":true,"description":"Time spent editing the candidate, in seconds"}},"type":"object","description":"Time spent editing each candidate"},"candidate_views":{"required":["id","candidate_id","created_at","anonymous"],"properties":{"id":{"format":"bigint","type":"integer","readOnly":true,"description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"candidate_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the related candidate\n\nNote:\nThis is a Foreign Key to `candidates.id`.<fk table='candidates' column='id'/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"anonymous":{"format":"boolean","type":"boolean","readOnly":true,"description":"Whether the candidate was viewed with personal information redacted"}},"type":"object","description":"Log of each time a candidate is viewed"},"candidates":{"required":["id","created_at","organization_id","updated_at","status","secret","secret_anonymous","values","language","attachments","name","secret_editable","export_filename","messages","section_attachments","fts"],"properties":{"id":{"default":"gen_random_uuid()","format":"uuid","type":"string","description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"organization_id":{"format":"uuid","type":"string","description":"Identifier of the related organization\n\nNote:\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>"},"updated_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Last modification timestamp"},"status":{"allOf":[{"$ref":"#/components/schemas/CandidateStatus"}],"description":"Status of the candidate. Only `active` candidates can be shared","readOnly":true},"secret":{"default":"regexp_replace(encode(extensions.gen_random_bytes(8), 'base64'::text), '[^a-zA-Z0-9]'::text, ''::text, 'g'::text)","format":"text","type":"string","readOnly":true,"description":"Secret string. Used to share the candidate's proposal privately, with personal information"},"secret_anonymous":{"default":"regexp_replace(encode(extensions.gen_random_bytes(8), 'base64'::text), '[^a-zA-Z0-9]'::text, ''::text, 'g'::text)","format":"text","type":"string","readOnly":true,"description":"Secret string. Used to share the candidate's proposal privately, with personal information redacted"},"layout_id":{"format":"uuid","type":"string","description":"Identifier of the related layout\n\nNote:\nThis is a Foreign Key to `layouts.id`.<fk table='layouts' column='id'/>"},"values":{"allOf":[{"$ref":"#/components/schemas/JsonObject"}],"description":"Values of the variables defined in the candidate's layout"},"language":{"allOf":[{"$ref":"#/components/schemas/Language"}],"description":"Language in which the candidate is displayed"},"member_id":{"format":"uuid","type":"string","description":"Identifier of the member responsible for the candidate, initially its creator\n\nNote:\nThis is a Foreign Key to `members.id`.<fk table='members' column='id'/>"},"attachments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CandidateAttachment"},"description":"Files attached to the candidate, such as CVs and vacancies"},"name":{"default":"","format":"text","type":"string","description":"Name of the candidate, used for search. Filled automatically when the candidate is edited in the app"},"avatar":{"format":"text","type":"string","description":"Avatar image of the candidate. Filled automatically when the candidate is edited in the app"},"secret_editable":{"default":"regexp_replace(encode(extensions.gen_random_bytes(8), 'base64'::text), '[^a-zA-Z0-9]'::text, ''::text, 'g'::text)","format":"text","type":"string","readOnly":true,"description":"Secret string. Used to share the candidate for editing"},"deleted_at":{"format":"timestamp with time zone","type":"string","description":"Deletion timestamp"},"export_filename":{"default":"","format":"text","type":"string","description":"Filename of exported PDF files (without .pdf). When empty, the layout's `export_filename` applies"},"external_data":{"allOf":[{"$ref":"#/components/schemas/CandidateExternalData"}],"description":"Data imported from an external source, such as an ATS","nullable":true},"messages":{"type":"array","items":{"$ref":"#/components/schemas/CandidateMessage"},"description":"Messages exchanged with the AI about the candidate"},"section_attachments":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/SectionAttachment"}},"description":"Attachments shown in each attachment section, by section"},"fts":{"format":"tsvector","type":"string","readOnly":true,"description":"Full text search index"}},"type":"object","description":"Candidates, with their attachments, values and sharing settings"},"credit_mutations":{"required":["id","created_at","delta"],"properties":{"id":{"default":"gen_random_uuid()","format":"uuid","type":"string","readOnly":true,"description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"organization_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the related organization\n\nNote:\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>"},"delta":{"format":"integer","type":"integer","readOnly":true,"description":"Change in credit: positive when credit is added, negative when it is used"},"billing_account_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the related billing account\n\nNote:\nThis is a Foreign Key to `billing_accounts.id`.<fk table='billing_accounts' column='id'/>"},"paddle_transaction_id":{"format":"text","type":"string","readOnly":true,"description":"Identifier of the Paddle transaction that bought the credit, if any"}},"type":"object","description":"Changes in the credit of billing accounts"},"layouts":{"required":["id","created_at","organization_id","updated_at","name","fts","visibility","secret","tokens","sections","featured","slug","variables","default_values","languages","assets","export_filename","share_instructions","description","page_height","page_width","custom_css"],"properties":{"id":{"default":"gen_random_uuid()","format":"uuid","type":"string","description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"creator_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the user that created this layout. Set automatically: the signed-in user, or the user who connected the OAuth app. Null for layouts created with an API key\n\nNote:\nThis is a Foreign Key to `user_profiles.user_id`.<fk table='user_profiles' column='user_id'/>"},"organization_id":{"format":"uuid","type":"string","description":"Identifier of the related organization\n\nNote:\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>"},"updated_at":{"default":"now()","format":"timestamp with time zone","type":"string","description":"Last modification timestamp"},"name":{"default":"","format":"text","type":"string","description":"Name of the layout"},"fts":{"format":"tsvector","type":"string","readOnly":true,"description":"Full text search index"},"thumbnail":{"format":"text","type":"string","description":"Thumbnail image of the layout. Generated automatically"},"visibility":{"allOf":[{"$ref":"#/components/schemas/LayoutVisibility"}],"description":"Visibility of the layout. `public` layouts are published to the layout library"},"secret":{"default":"gen_random_uuid()","format":"uuid","type":"string","readOnly":true,"description":"Secret string. Required to view the layout when its `visibility` is `private`"},"parent_id":{"format":"uuid","type":"string","description":"Identifier of the layout this layout was copied from\n\nNote:\nThis is a Foreign Key to `layouts.id`.<fk table='layouts' column='id'/>"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/LayoutDesignToken"},"description":"Design tokens used in the layout"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/LayoutSection"},"description":"Sections the layout consists of"},"featured":{"default":false,"format":"boolean","type":"boolean","readOnly":true,"description":"Whether the layout is featured in the layout library"},"slug":{"format":"text","type":"string","description":"Unique string to look up the layout in the layout library"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/LayoutVariable"},"description":"Variables used in the layout. Each candidate using the layout fills them in"},"default_values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonObject"},"description":"Default values of the layout's variables, per language. When empty, they are generated"},"languages":{"type":"array","items":{"$ref":"#/components/schemas/Language"},"minItems":1,"description":"Languages the layout is translated into. The first is the default"},"assets":{"type":"array","items":{"$ref":"#/components/schemas/LayoutAsset"},"description":"Reusable assets used in the layout"},"export_filename":{"default":"","format":"text","type":"string","description":"Filename of exported PDF files (without .pdf). Can contain {{variables}}"},"share_instructions":{"default":"","format":"text","type":"string","description":"Instructions shown in the share dialog, if any"},"web_settings":{"allOf":[{"$ref":"#/components/schemas/LayoutWebSettings"}],"description":"Settings for sharing the layout's proposals on the web","nullable":true},"archived_at":{"format":"timestamp with time zone","type":"string","description":"Archival timestamp"},"description":{"default":"","format":"text","type":"string","description":"Description of the layout, shown in the layout library"},"page_height":{"default":1123,"format":"integer","type":"integer","description":"Page height, in pixels"},"page_width":{"default":794,"format":"integer","type":"integer","description":"Page width, in pixels"},"custom_css":{"default":"","format":"text","type":"string","description":"Custom CSS applied to the layout"}},"type":"object","description":"Layouts, which candidates fill in to make proposals"},"members":{"required":["organization_id","user_id","created_at","id","updated_at","values","permissions"],"properties":{"organization_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the related organization\n\nNote:\nThis is a Primary Key.<pk/>\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>"},"user_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the related user\n\nNote:\nThis is a Primary Key.<pk/>\nThis is a Foreign Key to `user_profiles.user_id`.<fk table='user_profiles' column='user_id'/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"id":{"default":"gen_random_uuid()","format":"uuid","type":"string","readOnly":true,"description":"Unique identifier"},"updated_at":{"default":"now()","format":"timestamp with time zone","type":"string","description":"Last modification timestamp"},"values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MemberValue"},"description":"Values for each of the organization's `member_variables`, usable in layouts"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/Permission"},"description":"Permissions of the member"},"external_id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"Identifier of the member in an external system, used to match imported candidates","nullable":true}},"type":"object","description":"Links users to organizations, with their permissions"},"organizations":{"required":["id","created_at","name","updated_at","fts","slug","allowed_senders","status","allow_inspection","ats","member_variables","default_prompt","detect_candidate_language_from_attachment","proposal_by","proposal_reactions","model","enable_beta_integrations","external_variables","allow_word_output","billing_account_id","require_mfa","enable_data_tab","carerix_entity_kind","seven20_export_make_primary_cv_when_empty"],"properties":{"id":{"default":"gen_random_uuid()","format":"uuid","type":"string","readOnly":true,"description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"avatar":{"format":"text","type":"string","description":"Avatar image of the organization"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"deleted_at":{"format":"timestamp with time zone","type":"string","readOnly":true,"description":"Deletion timestamp"},"name":{"default":"","format":"text","type":"string","description":"Name of the organization"},"updated_at":{"default":"now()","format":"timestamp with time zone","type":"string","description":"Last modification timestamp"},"fts":{"format":"tsvector","type":"string","readOnly":true,"description":"Full text search index"},"type":{"allOf":[{"$ref":"#/components/schemas/OrganizationType"}],"description":"Type of the organization","nullable":true,"readOnly":true},"slug":{"default":"","format":"text","type":"string","description":"Unique string. The organization's candidate inbox is `{{slug}}@candidates.cv-transformer.com`"},"allowed_senders":{"format":"text[]","items":{"type":"string"},"type":"array","description":"Email addresses allowed to send CVs to the organization's inbox. Can be partial, like `*@example.com`"},"default_layout_id":{"format":"uuid","type":"string","description":"Identifier of the layout new candidates use by default\n\nNote:\nThis is a Foreign Key to `layouts.id`.<fk table='layouts' column='id'/>"},"delete_candidates_after":{"default":90,"format":"integer","type":"integer","description":"Number of days after which candidates are deleted automatically"},"status":{"allOf":[{"$ref":"#/components/schemas/OrganizationStatus"}],"description":"Internal status of the organization","readOnly":true},"allow_inspection":{"default":true,"format":"boolean","type":"boolean","description":"Whether the CV-Transformer team is allowed to inspect the organization to debug errors"},"ats":{"default":"","format":"text","type":"string","description":"The ATS this organization uses"},"member_variables":{"type":"array","items":{"$ref":"#/components/schemas/MemberVariable"},"description":"Variables defined on each member, usable in layouts"},"default_prompt":{"default":"","format":"text","type":"string","description":"Default prompt for filling in candidates"},"detect_candidate_language_from_attachment":{"default":false,"format":"boolean","type":"boolean","description":"Whether a candidate's language is detected from its first uploaded attachment"},"proposal_by":{"allOf":[{"$ref":"#/components/schemas/ProposalAuthor"}],"description":"Author shown on web proposals"},"proposal_reactions":{"type":"array","items":{"$ref":"#/components/schemas/ProposalReaction"},"description":"Reactions allowed on proposals"},"model":{"default":"mistral/codestral","format":"text","type":"string","description":"AI model the organization uses"},"active_ats_integration":{"allOf":[{"$ref":"#/components/schemas/IntegrationName"}],"description":"ATS integration that is currently active","nullable":true},"enable_beta_integrations":{"default":false,"format":"boolean","type":"boolean","readOnly":true,"description":"Whether integrations in beta are available to the organization"},"external_variables":{"type":"array","items":{"$ref":"#/components/schemas/LayoutVariable"},"description":"Variables of the data imported from the external integration"},"allow_word_output":{"default":false,"format":"boolean","type":"boolean","description":"Whether Word output is enabled for the organization"},"billing_account_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the billing account this organization belongs to\n\nNote:\nThis is a Foreign Key to `billing_accounts.id`.<fk table='billing_accounts' column='id'/>"},"require_mfa":{"default":false,"format":"boolean","type":"boolean","readOnly":true,"description":"Whether MFA is required for members to access this organization"},"bullhorn_corporation_id":{"format":"text","type":"string","readOnly":true,"description":"Identifier of the organization's corporation in Bullhorn"},"enable_data_tab":{"default":false,"format":"boolean","type":"boolean","readOnly":true},"bullhorn_private_label_id":{"format":"integer","type":"integer","readOnly":true,"description":"Identifier of the organization's private label in Bullhorn, used to match Bullhorn users to the organization"},"salesforce_instance_url":{"format":"text","type":"string","readOnly":true,"description":"URL of the organization's Salesforce instance"},"carerix_entity_kind":{"type":"string","enum":["CREmployee","CRMatch"],"description":"Carerix entity that candidates are linked to: a candidate (`CREmployee`) or a match (`CRMatch`)"},"carerix_attachment_node_type":{"format":"text","type":"string","description":"Identifier of the Carerix attachment type that exported files get"},"seven20_export_make_primary_cv_when_empty":{"default":true,"format":"boolean","type":"boolean","description":"Whether an export to Seven20 makes the CV primary when the candidate has no primary CV"}},"type":"object","description":"Organizations and their settings"},"user_profiles":{"required":["user_id","created_at","email","language","name","updated_at","phone","fts"],"properties":{"user_id":{"format":"uuid","type":"string","readOnly":true,"description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"avatar":{"format":"text","type":"string","readOnly":true,"description":"Avatar image of the user"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"email":{"format":"text","type":"string","readOnly":true,"description":"Email address of the user"},"language":{"allOf":[{"$ref":"#/components/schemas/Language"}],"description":"Language of the user","readOnly":true},"last_login_at":{"format":"timestamp with time zone","type":"string","readOnly":true,"description":"Last sign-in timestamp"},"name":{"default":"","format":"text","type":"string","readOnly":true,"description":"Name of the user"},"source":{"format":"text","type":"string","readOnly":true,"description":"How the user signed up, like `invite`"},"updated_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Last modification timestamp"},"phone":{"default":"","format":"text","type":"string","readOnly":true,"description":"Phone number of the user"},"invited_at":{"format":"timestamp with time zone","type":"string","readOnly":true,"description":"Last invitation timestamp"},"fts":{"format":"tsvector","type":"string","readOnly":true,"description":"Full text search index"}},"type":"object","description":"Profiles of users: their name, email address and language"},"webhook_notifications":{"required":["id","webhook_id","created_at","updated_at","event_type","payload","status","tries","created_on","next_attempt_at"],"properties":{"id":{"default":"extensions.uuid_generate_v4()","format":"uuid","type":"string","readOnly":true,"description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"webhook_id":{"format":"uuid","type":"string","readOnly":true,"description":"Identifier of the related webhook\n\nNote:\nThis is a Foreign Key to `webhooks.id`.<fk table='webhooks' column='id'/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Creation timestamp"},"updated_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"Last modification timestamp"},"event_type":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"}],"description":"Event this notification is for","readOnly":true},"payload":{"format":"jsonb","readOnly":true,"description":"JSON payload that is sent along with this notification: the object before (`old`, null for `.created` events) and after (`new`) the change. Member events add the user's `name` and `email` to both under `user_profiles`"},"status":{"allOf":[{"$ref":"#/components/schemas/WebhookNotificationStatus"}],"description":"Status of the notification","readOnly":true},"response":{"format":"text","type":"string","readOnly":true,"description":"Response body or error of the last delivery attempt, cut to 2,000 characters"},"tries":{"default":0,"format":"integer","type":"integer","readOnly":true,"description":"Number of delivery attempts"},"created_on":{"default":"CURRENT_DATE","format":"date","type":"string","readOnly":true,"description":"Date on which the notification was created"},"next_attempt_at":{"default":"now()","format":"timestamp with time zone","type":"string","readOnly":true,"description":"When the next delivery attempt is due, or the end of the claim of the attempt in progress"}},"type":"object","description":"Notifications of events, sent to webhooks"},"webhooks":{"required":["id","created_at","updated_at","endpoint","description","organization_id","events","signing_secret","source"],"properties":{"id":{"default":"gen_random_uuid()","format":"uuid","type":"string","description":"Unique identifier\n\nNote:\nThis is a Primary Key.<pk/>"},"created_at":{"default":"now()","format":"timestamp with time zone","type":"string","description":"Creation timestamp"},"updated_at":{"default":"now()","format":"timestamp with time zone","type":"string","description":"Last modification timestamp"},"endpoint":{"format":"text","type":"string","description":"URL notifications are sent to"},"description":{"default":"","format":"text","type":"string","description":"Description of the webhook, if any"},"organization_id":{"format":"uuid","type":"string","description":"Identifier of the related organization\n\nNote:\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>"},"events":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEvent"},"description":"Events to which the webhook is subscribed"},"signing_secret":{"default":"md5((random())::text)","format":"text","type":"string","readOnly":true,"description":"Secret used to sign each notification sent to the webhook. Verify notifications with the Standard Webhooks headers (webhook-id, webhook-timestamp, webhook-signature: HMAC-SHA256 with this secret as key). The X-Signature header (MD5) is deprecated and will be removed in the future"},"source":{"format":"text","type":"string","description":"Where the webhook was registered: the admin, the API or an external tool such as Zapier"},"disabled_at":{"format":"timestamp with time zone","type":"string","description":"When the webhook was disabled, because its endpoint kept failing or the OAuth grant that created it lost access. A disabled webhook gets no notifications; set this to null to enable it again"},"grant_id":{"format":"uuid","type":"string","description":"Identifier of the OAuth grant that created the webhook. Revoking the grant, or its access to the organization, disables the webhook\n\nNote:\nThis is a Foreign Key to `oauth_grants.id`.<fk table='oauth_grants' column='id'/>"}},"type":"object","description":"Endpoints that receive notifications of an organization's events"},"AttachmentMarking":{"type":"object","properties":{"color":{"type":"string"},"height":{"type":"number"},"left":{"type":"number"},"top":{"type":"number"},"width":{"type":"number"}},"required":["height","left","top","width"],"additionalProperties":false,"title":"AttachmentMarking"},"CandidateAttachment":{"type":"object","properties":{"detected_source_language":{"nullable":true,"type":"string"},"external_id":{"nullable":true,"anyOf":[{"type":"string"},{"type":"number"}]},"label":{"type":"string"},"markings":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentMarking"}}},"text":{"$ref":"#/components/schemas/MultiLanguageString"},"type":{"type":"string","enum":["image","image-pdf","link","pdf","text"]},"url":{"type":"string"}},"required":["detected_source_language","external_id","text","type","url"],"additionalProperties":false,"title":"CandidateAttachment"},"CandidateExternalData":{"type":"object","properties":{"avatar":{"nullable":true,"type":"string"},"name":{"type":"string"},"id":{"anyOf":[{"type":"string"},{"type":"number"}]},"url":{"type":"string"},"values":{"$ref":"#/components/schemas/Json"}},"required":["avatar","name","id","url","values"],"additionalProperties":false,"title":"CandidateExternalData"},"CandidateMessage":{"type":"object","properties":{"comment":{"type":"string"},"created_at":{"type":"string"},"id":{"type":"string"},"member_id":{"nullable":true,"type":"string"},"prompt":{"type":"string"},"selector":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"required":["comment","created_at","id","member_id","prompt"],"additionalProperties":false,"title":"CandidateMessage"},"CandidateStatus":{"type":"string","enum":["active","pending"],"title":"CandidateStatus"},"CurrencyCode":{"type":"string","enum":["USD","EUR","GBP","JPY","AUD","CAD","CHF","CLP","HKD","SGD","SEK","ARS","BRL","CNY","COP","CZK","DKK","HUF","ILS","INR","KRW","MXN","NOK","NZD","PEN","PLN","RUB","THB","TRY","TWD","UAH","VND","ZAR"],"title":"CurrencyCode"},"Error":{"type":"object","properties":{"code":{"description":"PostgreSQL or PostgREST error code","type":"string"},"details":{"nullable":true,"type":"string"},"hint":{"nullable":true,"type":"string"},"message":{"type":"string"}},"required":["details","hint","message"],"additionalProperties":false,"title":"Error"},"IntegrationName":{"type":"string","enum":["Bullhorn","Carerix","GreenhouseV3","JobAdder","Mercury","MySolution","Salesforce","Seven20","Tigris"],"title":"IntegrationName"},"Json":{"title":"Json","anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"string","nullable":true,"enum":[null]},{"type":"array","items":{"$ref":"#/components/schemas/Json"}},{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Json"}}]},"JsonObject":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Json"},"title":"JsonObject"},"Language":{"type":"string","enum":["en","cs","da-DK","de","en-GB","es","fr","ja-JP","nb-NO","nl","pt-BR","sv-SE","yue","zh"],"title":"Language"},"LayoutAsset":{"oneOf":[{"$ref":"#/components/schemas/LayoutFontAsset"},{"$ref":"#/components/schemas/LayoutImageAsset"}],"title":"LayoutAsset"},"LayoutBooleanExpression":{"title":"LayoutBooleanExpression","anyOf":[{"type":"boolean"},{"type":"string","enum":["anonymous","non-anonymous","web","pdf"]},{"type":"object","properties":{"max":{"nullable":true,"type":"number"},"min":{"nullable":true,"type":"number"},"selector":{"type":"string"}},"required":["max","min","selector"],"additionalProperties":false},{"type":"object","properties":{"condition":{"type":"string","enum":["empty","non-empty"]},"selector":{"type":"string"}},"required":["condition","selector"],"additionalProperties":false},{"type":"object","properties":{"condition":{"type":"string","enum":["equal-to","not-equal-to","greater-than","less-than"]},"selector":{"type":"string"},"value":{"type":"string"}},"required":["condition","selector","value"],"additionalProperties":false},{"type":"object","properties":{"condition":{"type":"string","enum":["and","or"]},"expressions":{"type":"array","items":{"$ref":"#/components/schemas/LayoutBooleanExpression"}}},"required":["condition","expressions"],"additionalProperties":false}]},"LayoutColorToken":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["color"]},"value":{"type":"string"}},"required":["id","name","type","value"],"additionalProperties":false,"title":"LayoutColorToken"},"LayoutConcatenationNodeDefinition":{"type":"object","properties":{"background":{"type":"string"},"border":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"borderRadius":{"anyOf":[{"type":"string"},{"type":"number"}]},"grow":{"type":"boolean"},"href":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"margin":{"anyOf":[{"type":"string"},{"type":"number"}]},"padding":{"anyOf":[{"type":"string"},{"type":"number"}]},"split":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["always"]}]},"transform":{"type":"string"},"visibility":{"$ref":"#/components/schemas/LayoutBooleanExpression"},"align":{"type":"string","enum":["left","center","right","justify"]},"bold":{"type":"boolean"},"color":{"type":"string"},"columns":{"type":"number"},"font":{"anyOf":[{"$ref":"#/components/schemas/LayoutFont"},{"type":"string"}]},"italic":{"type":"boolean"},"listStyle":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"strikethrough":{"type":"boolean"},"textTransform":{"type":"string","enum":["none","uppercase","lowercase","capitalize"]},"type":{"type":"string","enum":["concatenation"]},"underline":{"type":"boolean"},"value":{"$ref":"#/components/schemas/MultiLanguageString"},"prefix":{"$ref":"#/components/schemas/MultiLanguageString"},"selector":{"type":"string"},"separator":{"$ref":"#/components/schemas/MultiLanguageString"},"suffix":{"$ref":"#/components/schemas/MultiLanguageString"}},"required":["background","border","borderRadius","grow","id","margin","padding","split","transform","visibility","align","bold","color","columns","font","italic","listStyle","strikethrough","textTransform","type","underline","value","prefix","selector","separator","suffix"],"additionalProperties":false,"title":"LayoutConcatenationNodeDefinition"},"LayoutDateRangeVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"default":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}},"required":["end","start"],"additionalProperties":false},"precision":{"type":"string","enum":["year","month","day"]},"type":{"type":"string","enum":["date-range"]}},"required":["ai_instructions","key","sensitive","default","precision","type"],"additionalProperties":false,"title":"LayoutDateRangeVariable"},"LayoutDateVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"default":{"type":"string"},"precision":{"type":"string","enum":["year","month","day"]},"type":{"type":"string","enum":["date"]}},"required":["ai_instructions","key","sensitive","default","precision","type"],"additionalProperties":false,"title":"LayoutDateVariable"},"LayoutDesignToken":{"oneOf":[{"$ref":"#/components/schemas/LayoutColorToken"},{"$ref":"#/components/schemas/LayoutFontToken"},{"$ref":"#/components/schemas/LayoutLengthToken"}],"title":"LayoutDesignToken"},"LayoutEnumVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"default":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/MultiLanguageString"}},"type":{"type":"string","enum":["enum"]}},"required":["ai_instructions","key","sensitive","default","options","type"],"additionalProperties":false,"title":"LayoutEnumVariable"},"LayoutFont":{"type":"object","properties":{"family":{"nullable":true,"type":"string"},"letter_spacing":{"type":"number"},"line_height":{"type":"number"},"paragraph_spacing":{"type":"number"},"size":{"type":"number"}},"required":["family","letter_spacing","line_height","paragraph_spacing","size"],"additionalProperties":false,"title":"LayoutFont"},"LayoutFontAsset":{"type":"object","properties":{"family":{"type":"string"},"type":{"type":"string","enum":["font"]},"url":{"type":"string"}},"required":["family","type","url"],"additionalProperties":false,"title":"LayoutFontAsset"},"LayoutFontToken":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["font"]},"value":{"$ref":"#/components/schemas/LayoutFont"}},"required":["id","name","type","value"],"additionalProperties":false,"title":"LayoutFontToken"},"LayoutImageAsset":{"type":"object","properties":{"label":{"type":"string"},"type":{"type":"string","enum":["image"]},"url":{"type":"string"}},"required":["label","type","url"],"additionalProperties":false,"title":"LayoutImageAsset"},"LayoutImageNodeDefinition":{"type":"object","properties":{"background":{"type":"string"},"border":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"borderRadius":{"anyOf":[{"type":"string"},{"type":"number"}]},"grow":{"type":"boolean"},"href":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"margin":{"anyOf":[{"type":"string"},{"type":"number"}]},"padding":{"anyOf":[{"type":"string"},{"type":"number"}]},"split":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["always"]}]},"transform":{"type":"string"},"visibility":{"$ref":"#/components/schemas/LayoutBooleanExpression"},"aspect":{"nullable":true,"type":"string","enum":["1/1","4/3","16/9","2/1","3/4","9/16","1/2"]},"fit":{"type":"string","enum":["cover","contain"]},"src":{"type":"string"},"type":{"type":"string","enum":["image"]}},"required":["background","border","borderRadius","grow","id","margin","padding","split","transform","visibility","aspect","fit","src","type"],"additionalProperties":false,"title":"LayoutImageNodeDefinition"},"LayoutImageVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"type":{"type":"string","enum":["image"]}},"required":["ai_instructions","key","sensitive","type"],"additionalProperties":false,"title":"LayoutImageVariable"},"LayoutInlineTextVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"default":{"type":"string"},"max_length":{"nullable":true,"type":"number"},"min_length":{"type":"number"},"type":{"type":"string","enum":["inline-text"]}},"required":["ai_instructions","key","sensitive","default","max_length","min_length","type"],"additionalProperties":false,"title":"LayoutInlineTextVariable"},"LayoutJsonVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"default":{"$ref":"#/components/schemas/Json"},"type":{"type":"string","enum":["json"]}},"required":["ai_instructions","key","sensitive","default","type"],"additionalProperties":false,"title":"LayoutJsonVariable"},"LayoutLengthToken":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["length"]},"value":{"type":"number"}},"required":["id","name","type","value"],"additionalProperties":false,"title":"LayoutLengthToken"},"LayoutListNodeDefinition":{"type":"object","properties":{"background":{"type":"string"},"border":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"borderRadius":{"anyOf":[{"type":"string"},{"type":"number"}]},"grow":{"type":"boolean"},"href":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"margin":{"anyOf":[{"type":"string"},{"type":"number"}]},"padding":{"anyOf":[{"type":"string"},{"type":"number"}]},"split":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["always"]}]},"transform":{"type":"string"},"visibility":{"$ref":"#/components/schemas/LayoutBooleanExpression"},"align":{"type":"string","enum":["stretch","start","center","end"]},"divider":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"gap":{"anyOf":[{"type":"string"},{"type":"number"}]},"item":{"$ref":"#/components/schemas/LayoutNodeDefinition"},"justify":{"type":"string","enum":["start","center","end"]},"orientation":{"type":"string","enum":["horizontal","vertical"]},"selector":{"type":"string"},"type":{"type":"string","enum":["list"]}},"required":["background","border","borderRadius","grow","id","margin","padding","split","transform","visibility","align","divider","gap","item","justify","orientation","selector","type"],"additionalProperties":false,"title":"LayoutListNodeDefinition"},"LayoutListVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"default":{"nullable":true,"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/LayoutVariable"}},"max_length":{"nullable":true,"type":"number"},"min_length":{"type":"number"},"type":{"type":"string","enum":["list"]}},"required":["ai_instructions","key","sensitive","items","max_length","min_length","type"],"additionalProperties":false,"title":"LayoutListVariable"},"LayoutNodeBorder":{"type":"object","properties":{"color":{"type":"string"},"style":{"type":"string","enum":["solid","dashed","dotted"]},"width":{"anyOf":[{"type":"string"},{"type":"number"}]}},"required":["color","style","width"],"additionalProperties":false,"title":"LayoutNodeBorder"},"LayoutNodeDefinition":{"title":"LayoutNodeDefinition","oneOf":[{"$ref":"#/components/schemas/LayoutConcatenationNodeDefinition"},{"$ref":"#/components/schemas/LayoutImageNodeDefinition"},{"$ref":"#/components/schemas/LayoutListNodeDefinition"},{"$ref":"#/components/schemas/LayoutRatingNodeDefinition"},{"$ref":"#/components/schemas/LayoutRowNodeDefinition"},{"$ref":"#/components/schemas/LayoutStackNodeDefinition"},{"$ref":"#/components/schemas/LayoutTextNodeDefinition"},{"$ref":"#/components/schemas/LayoutWrappingRowNodeDefinition"}]},"LayoutNumberVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"default":{"nullable":true,"type":"number"},"max":{"nullable":true,"type":"number"},"min":{"nullable":true,"type":"number"},"type":{"type":"string","enum":["number"]}},"required":["ai_instructions","key","sensitive","default","max","min","type"],"additionalProperties":false,"title":"LayoutNumberVariable"},"LayoutObjectVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"fields":{"type":"array","items":{"$ref":"#/components/schemas/LayoutVariable"}},"type":{"type":"string","enum":["object"]}},"required":["ai_instructions","key","sensitive","fields","type"],"additionalProperties":false,"title":"LayoutObjectVariable"},"LayoutRatingNodeDefinition":{"type":"object","properties":{"background":{"type":"string"},"border":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"borderRadius":{"anyOf":[{"type":"string"},{"type":"number"}]},"grow":{"type":"boolean"},"href":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"margin":{"anyOf":[{"type":"string"},{"type":"number"}]},"padding":{"anyOf":[{"type":"string"},{"type":"number"}]},"split":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["always"]}]},"transform":{"type":"string"},"visibility":{"$ref":"#/components/schemas/LayoutBooleanExpression"},"color":{"type":"string"},"selector":{"type":"string"},"size":{"anyOf":[{"type":"string"},{"type":"number"}]},"style":{"type":"string"},"type":{"type":"string","enum":["rating"]}},"required":["background","border","borderRadius","grow","id","margin","padding","split","transform","visibility","color","selector","size","style","type"],"additionalProperties":false,"title":"LayoutRatingNodeDefinition"},"LayoutRatingVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"default":{"type":"number"},"type":{"type":"string","enum":["rating"]}},"required":["ai_instructions","key","sensitive","default","type"],"additionalProperties":false,"title":"LayoutRatingVariable"},"LayoutRowNodeDefinition":{"type":"object","properties":{"background":{"type":"string"},"border":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"borderRadius":{"anyOf":[{"type":"string"},{"type":"number"}]},"grow":{"type":"boolean"},"href":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"margin":{"anyOf":[{"type":"string"},{"type":"number"}]},"padding":{"anyOf":[{"type":"string"},{"type":"number"}]},"split":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["always"]}]},"transform":{"type":"string"},"visibility":{"$ref":"#/components/schemas/LayoutBooleanExpression"},"align":{"type":"string","enum":["stretch","start","center","end"]},"divider":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"gap":{"anyOf":[{"type":"string"},{"type":"number"}]},"columns":{"type":"array","items":{"type":"object","properties":{"node":{"$ref":"#/components/schemas/LayoutNodeDefinition"},"width":{"type":"number"}},"required":["node","width"],"additionalProperties":false}},"type":{"type":"string","enum":["row"]}},"required":["background","border","borderRadius","grow","id","margin","padding","split","transform","visibility","align","divider","gap","columns","type"],"additionalProperties":false,"title":"LayoutRowNodeDefinition"},"LayoutSection":{"oneOf":[{"type":"object","properties":{"footer":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LayoutNodeDefinition"}]},"header":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LayoutNodeDefinition"}]},"id":{"type":"string"},"label":{"type":"string"},"candidate_attachments":{"type":"boolean"},"static_attachments":{"type":"array","items":{"$ref":"#/components/schemas/CandidateAttachment"}},"type":{"type":"string","enum":["attachment"]}},"required":["footer","header","id","label","type"],"additionalProperties":false},{"type":"object","properties":{"footer":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LayoutNodeDefinition"}]},"header":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LayoutNodeDefinition"}]},"id":{"type":"string"},"label":{"type":"string"},"body":{"$ref":"#/components/schemas/LayoutNodeDefinition"},"type":{"type":"string","enum":["multi-page"]}},"required":["footer","header","id","label","body","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"node":{"$ref":"#/components/schemas/LayoutNodeDefinition"},"type":{"type":"string","enum":["single-page"]}},"required":["id","label","node","type"],"additionalProperties":false}],"title":"LayoutSection"},"LayoutStackNodeDefinition":{"type":"object","properties":{"background":{"type":"string"},"border":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"borderRadius":{"anyOf":[{"type":"string"},{"type":"number"}]},"grow":{"type":"boolean"},"href":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"margin":{"anyOf":[{"type":"string"},{"type":"number"}]},"padding":{"anyOf":[{"type":"string"},{"type":"number"}]},"split":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["always"]}]},"transform":{"type":"string"},"visibility":{"$ref":"#/components/schemas/LayoutBooleanExpression"},"align":{"type":"string","enum":["stretch","start","center","end"]},"divider":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"gap":{"anyOf":[{"type":"string"},{"type":"number"}]},"children":{"type":"array","items":{"$ref":"#/components/schemas/LayoutNodeDefinition"}},"justify":{"type":"string","enum":["start","center","end"]},"type":{"type":"string","enum":["stack"]}},"required":["background","border","borderRadius","grow","id","margin","padding","split","transform","visibility","align","divider","gap","children","justify","type"],"additionalProperties":false,"title":"LayoutStackNodeDefinition"},"LayoutTextBlockVariable":{"type":"object","properties":{"ai_instructions":{"anyOf":[{"type":"boolean","enum":[false]},{"type":"string"}]},"key":{"type":"string"},"sensitive":{"type":"boolean"},"static":{"type":"boolean","enum":[true]},"default":{"type":"string"},"max_length":{"nullable":true,"type":"number"},"min_length":{"type":"number"},"type":{"type":"string","enum":["text-block"]}},"required":["ai_instructions","key","sensitive","default","max_length","min_length","type"],"additionalProperties":false,"title":"LayoutTextBlockVariable"},"LayoutTextNodeDefinition":{"type":"object","properties":{"background":{"type":"string"},"border":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"borderRadius":{"anyOf":[{"type":"string"},{"type":"number"}]},"grow":{"type":"boolean"},"href":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"margin":{"anyOf":[{"type":"string"},{"type":"number"}]},"padding":{"anyOf":[{"type":"string"},{"type":"number"}]},"split":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["always"]}]},"transform":{"type":"string"},"visibility":{"$ref":"#/components/schemas/LayoutBooleanExpression"},"align":{"type":"string","enum":["left","center","right","justify"]},"bold":{"type":"boolean"},"color":{"type":"string"},"columns":{"type":"number"},"font":{"anyOf":[{"$ref":"#/components/schemas/LayoutFont"},{"type":"string"}]},"italic":{"type":"boolean"},"listStyle":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"strikethrough":{"type":"boolean"},"textTransform":{"type":"string","enum":["none","uppercase","lowercase","capitalize"]},"type":{"type":"string","enum":["text"]},"underline":{"type":"boolean"},"value":{"$ref":"#/components/schemas/MultiLanguageString"}},"required":["background","border","borderRadius","grow","id","margin","padding","split","transform","visibility","align","bold","color","columns","font","italic","listStyle","strikethrough","textTransform","type","underline","value"],"additionalProperties":false,"title":"LayoutTextNodeDefinition"},"LayoutVariable":{"title":"LayoutVariable","anyOf":[{"$ref":"#/components/schemas/LayoutDateRangeVariable"},{"$ref":"#/components/schemas/LayoutDateVariable"},{"$ref":"#/components/schemas/LayoutEnumVariable"},{"$ref":"#/components/schemas/LayoutImageVariable"},{"$ref":"#/components/schemas/LayoutInlineTextVariable"},{"$ref":"#/components/schemas/LayoutJsonVariable"},{"$ref":"#/components/schemas/LayoutListVariable"},{"$ref":"#/components/schemas/LayoutNumberVariable"},{"$ref":"#/components/schemas/LayoutObjectVariable"},{"$ref":"#/components/schemas/LayoutRatingVariable"},{"$ref":"#/components/schemas/LayoutTextBlockVariable"}]},"LayoutVisibility":{"type":"string","enum":["private","public"],"title":"LayoutVisibility"},"LayoutWebSettings":{"type":"object","properties":{"color_accent":{"type":"string"},"color_background":{"type":"string"},"color_text":{"type":"string"}},"required":["color_accent","color_background","color_text"],"additionalProperties":false,"title":"LayoutWebSettings"},"LayoutWrappingRowNodeDefinition":{"type":"object","properties":{"background":{"type":"string"},"border":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"borderRadius":{"anyOf":[{"type":"string"},{"type":"number"}]},"grow":{"type":"boolean"},"href":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"margin":{"anyOf":[{"type":"string"},{"type":"number"}]},"padding":{"anyOf":[{"type":"string"},{"type":"number"}]},"split":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["always"]}]},"transform":{"type":"string"},"visibility":{"$ref":"#/components/schemas/LayoutBooleanExpression"},"align":{"type":"string","enum":["stretch","start","center","end"]},"divider":{"allOf":[{"$ref":"#/components/schemas/LayoutNodeBorder"}],"nullable":true},"gap":{"anyOf":[{"type":"string"},{"type":"number"}]},"children":{"type":"array","items":{"$ref":"#/components/schemas/LayoutNodeDefinition"}},"justify":{"type":"string","enum":["start","center","end"]},"type":{"type":"string","enum":["wrapping-row"]}},"required":["background","border","borderRadius","grow","id","margin","padding","split","transform","visibility","align","divider","gap","children","justify","type"],"additionalProperties":false,"title":"LayoutWrappingRowNodeDefinition"},"MemberValue":{"anyOf":[{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}},"required":["start","end"],"additionalProperties":false},{"type":"string"},{"type":"number"},{"type":"string","nullable":true,"enum":[null]}],"title":"MemberValue"},"MemberVariable":{"anyOf":[{"$ref":"#/components/schemas/LayoutInlineTextVariable"},{"$ref":"#/components/schemas/LayoutNumberVariable"},{"$ref":"#/components/schemas/LayoutTextBlockVariable"}],"title":"MemberVariable"},"MultiLanguageString":{"type":"object","properties":{"default":{"type":"string"}},"required":["default"],"additionalProperties":{"type":"string"},"title":"MultiLanguageString"},"OrganizationStatus":{"type":"string","enum":["active","inactive"],"title":"OrganizationStatus"},"OrganizationType":{"type":"string","enum":["ats","regular","test"],"title":"OrganizationType"},"Permission":{"type":"string","enum":["billing","edit_candidates","edit_layouts","settings","team","view_candidates"],"title":"Permission"},"PricingVersion":{"type":"string","enum":["v1","v2","v3"],"title":"PricingVersion"},"ProposalAuthor":{"type":"string","enum":["contact","organization"],"title":"ProposalAuthor"},"ProposalEmailReaction":{"type":"object","properties":{"body":{"type":"string"},"id":{"type":"string"},"subject":{"type":"string"},"type":{"type":"string","enum":["email"]}},"required":["body","id","subject","type"],"additionalProperties":false,"title":"ProposalEmailReaction"},"ProposalLinkReaction":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["link"]},"url":{"type":"string"}},"required":["id","type","url"],"additionalProperties":false,"title":"ProposalLinkReaction"},"ProposalReaction":{"oneOf":[{"$ref":"#/components/schemas/ProposalEmailReaction"},{"$ref":"#/components/schemas/ProposalLinkReaction"}],"title":"ProposalReaction"},"SectionAttachment":{"type":"object","properties":{"attachment_id":{"type":"string"},"grid":{"$ref":"#/components/schemas/SectionAttachmentGrid"}},"required":["attachment_id"],"additionalProperties":false,"title":"SectionAttachment"},"SectionAttachmentGrid":{"type":"object","properties":{"columns":{"type":"number"},"rows":{"type":"number"}},"required":["columns","rows"],"additionalProperties":false,"title":"SectionAttachmentGrid"},"SubscriptionType":{"type":"string","enum":["pre-paid","subscription","trial"],"title":"SubscriptionType"},"WebhookEvent":{"type":"string","enum":["candidates.created","candidates.updated","layouts.created","layouts.updated","members.created","members.updated"],"title":"WebhookEvent"},"WebhookNotificationStatus":{"type":"string","enum":["error","pending","sent"],"title":"WebhookNotificationStatus"}},"securitySchemes":{"apiKey":{"description":"Your API key, sent as `Bearer YOUR_API_KEY`","scheme":"bearer","type":"http"},"oauth2":{"description":"OAuth 2.1 with PKCE, for apps and AI agents acting for a user. Clients register dynamically or with a client ID metadata document. See /.well-known/oauth-authorization-server.","flows":{"authorizationCode":{"authorizationUrl":"https://www.cv-transformer.com/oauth/authorize","refreshUrl":"https://www.cv-transformer.com/oauth/token","scopes":{"candidates:read":"Read candidates, their proposals, views and analytics","candidates:write":"Read and change candidates, their proposals, views and analytics","layouts:read":"Read layouts","layouts:write":"Read and change layouts","members:read":"Read members and their profiles, and invitations","members:write":"Read and change members and their profiles, and invitations","organization:read":"Read organization details, billing, credits and api usage","organization:write":"Read and change organization details, billing, credits and api usage","webhooks:read":"Read webhooks and their notifications","webhooks:write":"Read and change webhooks and their notifications"},"tokenUrl":"https://www.cv-transformer.com/oauth/token"}},"type":"oauth2"}}},"x-scopes":{"candidates:read":"Read candidates, their proposals, views and analytics","candidates:write":"Read and change candidates, their proposals, views and analytics","layouts:read":"Read layouts","layouts:write":"Read and change layouts","members:read":"Read members and their profiles, and invitations","members:write":"Read and change members and their profiles, and invitations","organization:read":"Read organization details, billing, credits and api usage","organization:write":"Read and change organization details, billing, credits and api usage","webhooks:read":"Read webhooks and their notifications","webhooks:write":"Read and change webhooks and their notifications"}}