CV-Transformer API reference

With the CV-Transformer API you can access and manage your data in a programmatic way, using HTTP requests. The structure of the CV Transformer API is based on PostgREST v11.1 .

Authentication

The CV-Transformer API uses api keys for authentication. You can create and manage API keys from the bottom of settings page of your organization in the admin dashboard .
Once you have an API key simply provide it in the HTTP Authorization header as bearer token.

Example

curl -X GET "https://www.cv-transformer.com/api/v1/layouts" \
  -H "Authorization: Bearer YOUR_API_KEY"

Selecting data

For each endpoint, you can select which columns you want to retrieve by using the select query parameter. Besides the columns of the resource itself, you can also select columns from related resources. For more advanced selection options refer to the PostgREST documentation .

Selecting all columns

curl -X GET "https://www.cv-transformer.com/api/v1/layouts?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Selecting specific columns

curl -X GET "https://www.cv-transformer.com/api/v1/layouts?select=id,name" \
  -H "Authorization: Bearer YOUR_API_KEY"

Including data from related tables

curl -X GET "https://www.cv-transformer.com/api/v1/layouts?select=name,candidates(*)" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filtering

Filters can be applied on each list, update and delete request, to restrict the rows affected by the request. For a complete list of filters refer to the PostgREST documentation .

Listing confirmed calendar_events

curl -X GET "https://www.cv-transformer.com/api/v1/calendar_events?status=eq.CONFIRMED" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filtering by multiple columns

curl -X GET "https://www.cv-transformer.com/api/v1/calendar_events?status=eq.CONFIRMED&type=eq.booking" \
  -H "Authorization: Bearer YOUR_API_KEY"

Deleting test contacts

curl -X DELETE "https://www.cv-transformer.com/api/v1/contacts?email=like.%test.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sorting & pagination

By default, results are sorted by the primary key of the underlying table. You can change the sorting by using the order query parameter. To limit the number of results, use the limit and offset query parameters. The API will return at most 1000 results per request. For more advanced sorting and pagination options refer to the PostgREST documentation .

Sorting by creation date

curl -X GET "https://www.cv-transformer.com/api/v1/layouts?order=created_at.desc" \
  -H "Authorization: Bearer YOUR_API_KEY"

Limiting the number of results

curl -X GET "https://www.cv-transformer.com/api/v1/layouts?limit=10&offset=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Candidate views

Endpoints

GET/candidate_views

The candidate view object

Attributes

idbigint

Unique identifier

candidate_iduuid

candidates.id

Identifier of the related candidate

created_attimestamp with time zone

Creation timestamp

anonymousboolean

Whether the candidate was viewed with personal information redacted or not

The candidate view object

{
  "id": 0,
  "candidate_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.154Z",
  "anonymous": false
}

List candidate views

Filters

idFilter<string>

Unique identifier

candidate_idFilter<string>

Identifier of the related candidate

created_atFilter<string>

Creation timestamp

anonymousFilter<string>

Whether the candidate was viewed with personal information redacted or not

Responses

200

A list of candidate views with the selected columns

206

Partial Content

GET /candidate_views

curl -X GET "https://www.cv-transformer.com/api/v1/candidate_views?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Candidates

Endpoints

GET/candidatesDELETE/candidatesPATCH/candidatesPOST/candidates/createPOST/candidates/[candidate_id]/attachPOST/candidates/[candidate_id]/fill

The candidate object

Attributes

iduuid

Unique identifier

creator_iduuid | null

Identifier of the user that created this candidate

layout_iduuid | null

layouts.id

Identifier of the related layout

organization_iduuid

organizations.id

Identifier of the related organization

proposal_iduuid

Identifier used for sharing candidates

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

cvjsonb | null

Data for the CV attached to this candidate. CandidateAttachment

datajsonb

The standard data related to this candidate. CandidateData

ftstsvector

secretuuid

Secret string. Used to privately share a proposal for this candidate with personal information non-redacted

secret_anonymousuuid

Secret string. Used to privately share a proposal for this candidate with personal information redacted

statustext

Status of the candidate. Only active candidates can be shared

vacancyjsonb | null

Data for the vacancy attached to this candidate. CandidateAttachment

valuesjsonb

Key-value object containing values for each of the variables defined in the layout related to the candidate

The candidate object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "creator_id": "00000000-0000-0000-0000-000000000000",
  "layout_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "proposal_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.195Z",
  "updated_at": "2025-01-22T23:11:50.195Z",
  "cv": {},
  "data": {},
  "secret": "00000000-0000-0000-0000-000000000000",
  "secret_anonymous": "00000000-0000-0000-0000-000000000000",
  "status": "pending",
  "vacancy": {},
  "values": {}
}

List candidates

Filters

idFilter<string>

Unique identifier

creator_idFilter<string>

Identifier of the user that created this candidate

layout_idFilter<string>

Identifier of the related layout

organization_idFilter<string>

Identifier of the related organization

proposal_idFilter<string>

Identifier used for sharing candidates

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

cvFilter<string>

Data for the CV attached to this candidate. CandidateAttachment

dataFilter<string>

The standard data related to this candidate. CandidateData

ftsFilter<string>

secretFilter<string>

Secret string. Used to privately share a proposal for this candidate with personal information non-redacted

secret_anonymousFilter<string>

Secret string. Used to privately share a proposal for this candidate with personal information redacted

statusFilter<string>

Status of the candidate. Only active candidates can be shared

vacancyFilter<string>

Data for the vacancy attached to this candidate. CandidateAttachment

valuesFilter<string>

Key-value object containing values for each of the variables defined in the layout related to the candidate

Responses

200

A list of candidates with the selected columns

206

Partial Content

GET /candidates

curl -X GET "https://www.cv-transformer.com/api/v1/candidates?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Delete candidates

Filters

idFilter<string>

Unique identifier

creator_idFilter<string>

Identifier of the user that created this candidate

layout_idFilter<string>

Identifier of the related layout

organization_idFilter<string>

Identifier of the related organization

proposal_idFilter<string>

Identifier used for sharing candidates

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

cvFilter<string>

Data for the CV attached to this candidate. CandidateAttachment

dataFilter<string>

The standard data related to this candidate. CandidateData

ftsFilter<string>

secretFilter<string>

Secret string. Used to privately share a proposal for this candidate with personal information non-redacted

secret_anonymousFilter<string>

Secret string. Used to privately share a proposal for this candidate with personal information redacted

statusFilter<string>

Status of the candidate. Only active candidates can be shared

vacancyFilter<string>

Data for the vacancy attached to this candidate. CandidateAttachment

valuesFilter<string>

Key-value object containing values for each of the variables defined in the layout related to the candidate

Responses

204

The deleted candidates with the selected columns

DELETE /candidates

curl -X DELETE "https://www.cv-transformer.com/api/v1/candidates" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update candidates

Filters

idFilter<string>

Unique identifier

creator_idFilter<string>

Identifier of the user that created this candidate

layout_idFilter<string>

Identifier of the related layout

organization_idFilter<string>

Identifier of the related organization

proposal_idFilter<string>

Identifier used for sharing candidates

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

cvFilter<string>

Data for the CV attached to this candidate. CandidateAttachment

dataFilter<string>

The standard data related to this candidate. CandidateData

ftsFilter<string>

secretFilter<string>

Secret string. Used to privately share a proposal for this candidate with personal information non-redacted

secret_anonymousFilter<string>

Secret string. Used to privately share a proposal for this candidate with personal information redacted

statusFilter<string>

Status of the candidate. Only active candidates can be shared

vacancyFilter<string>

Data for the vacancy attached to this candidate. CandidateAttachment

valuesFilter<string>

Key-value object containing values for each of the variables defined in the layout related to the candidate

Body

Partial<Candidate>

Responses

204

The updated candidates with the selected columns

PATCH /candidates

curl -X PATCH "https://www.cv-transformer.com/api/v1/candidates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'

Create candidate

Create a new candidate. Uses one credit. When no credits are available in the organization, the candidate is created with status="pending" instead.

Body

Partial<Candidate>

Responses

200

The created candidate

POST /candidates/create

curl -X POST "https://www.cv-transformer.com/api/v1/candidates/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "cv": {
      "text": "",
      "type": "link",
      "url": "https://example.com/cv"
    },
    "data": {},
    "layout_id": "00000000-0000-0000-0000-000000000000",
    "vacancy": {
      "text": "",
      "type": "link",
      "url": "https://example.com/vacancy"
    },
    "values": {
      "key": "value"
    }
  }'

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "creator_id": "00000000-0000-0000-0000-000000000000",
  "layout_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "proposal_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.359Z",
  "updated_at": "2025-01-22T23:11:50.359Z",
  "cv": {},
  "data": {},
  "secret": "00000000-0000-0000-0000-000000000000",
  "secret_anonymous": "00000000-0000-0000-0000-000000000000",
  "status": "pending",
  "vacancy": {},
  "values": {}
}

Upload candidate attachment

Upload an attachment for a candidate.

Query parameters

location"cv" | "vacancy"

The type of attachment to upload. Either a CV or a vacancy. Defaults to CV.

Body

The file to attach. Supported file-types: .pdf, .doc, .docx, .jpeg, .png, .webp

Responses

200

The updated candidate

POST /candidates/[candidate_id]/attach

curl -X POST "https://www.cv-transformer.com/api/v1/candidates/[candidate_id]/attach?location=cv" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "creator_id": "00000000-0000-0000-0000-000000000000",
  "layout_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "proposal_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.360Z",
  "updated_at": "2025-01-22T23:11:50.360Z",
  "cv": {},
  "data": {},
  "secret": "00000000-0000-0000-0000-000000000000",
  "secret_anonymous": "00000000-0000-0000-0000-000000000000",
  "status": "pending",
  "vacancy": {},
  "values": {}
}

Fill candidate data

Fill a candidate's data given from its uploaded CV.

Route parameters

candidate_idrequireduuid

The identifier of the candidate to fill.

Query parameters

stylestring

The style in which to fill the candidate, e.g., "Third person", "Formal". Leave empty for default style.

Responses

200

The updated candidate

POST /candidates/[candidate_id]/fill

curl -X POST "https://www.cv-transformer.com/api/v1/candidates/[candidate_id]/fill?style=" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "creator_id": "00000000-0000-0000-0000-000000000000",
  "layout_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "proposal_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.374Z",
  "updated_at": "2025-01-22T23:11:50.374Z",
  "cv": {},
  "data": {},
  "secret": "00000000-0000-0000-0000-000000000000",
  "secret_anonymous": "00000000-0000-0000-0000-000000000000",
  "status": "pending",
  "vacancy": {},
  "values": {}
}

Credit mutations

Endpoints

GET/credit_mutations

The credit mutation object

Attributes

iduuid

Unique identifier

organization_iduuid

organizations.id

Identifier of the organization related to this mutation

created_attimestamp with time zone

Creation timestamp

deltainteger

Difference between next and previous credit

The credit mutation object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.374Z",
  "delta": 0
}

List credit mutations

Filters

idFilter<string>

Unique identifier

organization_idFilter<string>

Identifier of the organization related to this mutation

created_atFilter<string>

Creation timestamp

deltaFilter<string>

Difference between next and previous credit

Responses

200

A list of credit mutations with the selected columns

206

Partial Content

GET /credit_mutations

curl -X GET "https://www.cv-transformer.com/api/v1/credit_mutations?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Layouts

Endpoints

GET/layoutsPOST/layoutsDELETE/layoutsPATCH/layouts

The layout object

Attributes

iduuid

Unique identifier

creator_iduuid | null

Identifier of the user that created this layout

organization_iduuid

organizations.id

Identifier of the related organization

parent_iduuid | null

layouts.id

Identifier of the layout this layout originates from

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

featuredboolean

Whether the layout is featured in the layout library

ftstsvector

languagetext

Language this layout is written in

nametext

Title of this layout

secretuuid

Secret string. Required to view the layout when its visibility is "private"

sectionsjsonb

List of LayoutSection

slugtext

Unique identifier that allows easy lookup in the layout library

thumbnailtext | null

Thumbnail image for this layout

variablesjsonb

List of LayoutVariable

visibilitytext

Visibility of this layout. "public" means the layout is published to the layout library.

The layout object

{
  "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": "2025-01-22T23:11:50.396Z",
  "updated_at": "2025-01-22T23:11:50.396Z",
  "featured": false,
  "language": "nl",
  "name": "",
  "secret": "00000000-0000-0000-0000-000000000000",
  "sections": {},
  "slug": "",
  "thumbnail": "",
  "variables": {},
  "visibility": "private"
}

List layouts

Filters

idFilter<string>

Unique identifier

creator_idFilter<string>

Identifier of the user that created this layout

organization_idFilter<string>

Identifier of the related organization

parent_idFilter<string>

Identifier of the layout this layout originates from

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

featuredFilter<string>

Whether the layout is featured in the layout library

ftsFilter<string>

languageFilter<string>

Language this layout is written in

nameFilter<string>

Title of this layout

secretFilter<string>

Secret string. Required to view the layout when its visibility is "private"

sectionsFilter<string>

List of LayoutSection

slugFilter<string>

Unique identifier that allows easy lookup in the layout library

thumbnailFilter<string>

Thumbnail image for this layout

variablesFilter<string>

List of LayoutVariable

visibilityFilter<string>

Visibility of this layout. "public" means the layout is published to the layout library.

Responses

200

A list of layouts with the selected columns

206

Partial Content

GET /layouts

curl -X GET "https://www.cv-transformer.com/api/v1/layouts?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create layouts

Body

Partial<Layout>
 | Array<Partial<Layout>>

Responses

201

The newly created layouts with the selected columns

POST /layouts

curl -X POST "https://www.cv-transformer.com/api/v1/layouts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[]'

Delete layouts

Filters

idFilter<string>

Unique identifier

creator_idFilter<string>

Identifier of the user that created this layout

organization_idFilter<string>

Identifier of the related organization

parent_idFilter<string>

Identifier of the layout this layout originates from

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

featuredFilter<string>

Whether the layout is featured in the layout library

ftsFilter<string>

languageFilter<string>

Language this layout is written in

nameFilter<string>

Title of this layout

secretFilter<string>

Secret string. Required to view the layout when its visibility is "private"

sectionsFilter<string>

List of LayoutSection

slugFilter<string>

Unique identifier that allows easy lookup in the layout library

thumbnailFilter<string>

Thumbnail image for this layout

variablesFilter<string>

List of LayoutVariable

visibilityFilter<string>

Visibility of this layout. "public" means the layout is published to the layout library.

Responses

204

The deleted layouts with the selected columns

DELETE /layouts

curl -X DELETE "https://www.cv-transformer.com/api/v1/layouts" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update layouts

Filters

idFilter<string>

Unique identifier

creator_idFilter<string>

Identifier of the user that created this layout

organization_idFilter<string>

Identifier of the related organization

parent_idFilter<string>

Identifier of the layout this layout originates from

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

featuredFilter<string>

Whether the layout is featured in the layout library

ftsFilter<string>

languageFilter<string>

Language this layout is written in

nameFilter<string>

Title of this layout

secretFilter<string>

Secret string. Required to view the layout when its visibility is "private"

sectionsFilter<string>

List of LayoutSection

slugFilter<string>

Unique identifier that allows easy lookup in the layout library

thumbnailFilter<string>

Thumbnail image for this layout

variablesFilter<string>

List of LayoutVariable

visibilityFilter<string>

Visibility of this layout. "public" means the layout is published to the layout library.

Body

Partial<Layout>

Responses

204

The updated layouts with the selected columns

PATCH /layouts

curl -X PATCH "https://www.cv-transformer.com/api/v1/layouts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'

Members

Endpoints

GET/membersPOST/members/invitePOST/members/[member_id]/revoke

The member object

Attributes

iduuid

Unique identifier

organization_iduuid

organizations.id

Identifier of the related organization

user_iduuid

Identifier of the related user

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

role"user" | "admin" | "superuser"

Role of the member

The member object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.515Z",
  "updated_at": "2025-01-22T23:11:50.515Z",
  "role": "superuser"
}

List members

Filters

idFilter<string>

Unique identifier

organization_idFilter<string>

Identifier of the related organization

user_idFilter<string>

Identifier of the related user

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

roleFilter<string>

Role of the member

Responses

200

A list of members with the selected columns

206

Partial Content

GET /members

curl -X GET "https://www.cv-transformer.com/api/v1/members?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Invite member

Invite a member to your organization. The member will receive an email with a link to accept the invitation. The member will have the user role. To make a member admin or superuser use the dashboard.

Body

emailrequiredstring

The email address of the member to invite.

namestring

The name of the member to invite.

language"en" | "nl"

The language of the member to invite.

Responses

201

The invited member

POST /members/invite

curl -X POST "https://www.cv-transformer.com/api/v1/members/invite" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "email": "johndoe@example.com",
    "name": "John Doe"
  }'

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.535Z",
  "updated_at": "2025-01-22T23:11:50.535Z",
  "role": "superuser",
  "user_profile": {
    "user_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2025-01-22T23:11:50.535Z",
    "updated_at": "2025-01-22T23:11:50.535Z",
    "avatar": "",
    "email": "",
    "language": "nl",
    "last_login_at": "2025-01-22T23:11:50.535Z",
    "name": "",
    "phone": "",
    "source": ""
  }
}

Revoke member

Revoke a member from your organization. The member will no longer have access to your organization. Only works for members with the user role. To revoke an admin or superuser members use the dashboard.

Parameters

member_idrequireduuid

The identifier of the member to revoke.

Responses

200

Status message:

{ status: "ok" }

POST /members/[member_id]/revoke

curl -X POST "https://www.cv-transformer.com/api/v1/members/[member_id]/revoke" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status": "ok"
}

Organizations

Endpoints

GET/organizationsPATCH/organizations

The organization object

Attributes

iduuid

Unique identifier

default_layout_iduuid | null

layouts.id

Identifier of the layout that is used for new candidates by default

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

deleted_attimestamp with time zone | null

Deletion timestamp

activeboolean | null

allowed_senderstext[]

List of email addresses that are allowed to send CV's to the organizations inbox. Email addresses can be partial (e.g., *@example.com)

avatartext | null

Avatar image representing the organization

creditinteger

Amount of credit currently available

delete_candidates_afterinteger | null

Time in days after which candidates are automatically deleted

ftstsvector

nametext

Name of the organization

slugtext

Unique string. Used to determine the organization's email inbox address

typetext | null

Type of the organization

The organization object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "default_layout_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.535Z",
  "updated_at": "2025-01-22T23:11:50.535Z",
  "deleted_at": "2025-01-22T23:11:50.535Z",
  "active": false,
  "allowed_senders": [
    ""
  ],
  "avatar": "",
  "credit": 10,
  "delete_candidates_after": 0,
  "name": "",
  "slug": "",
  "type": "regular"
}

List organizations

Filters

idFilter<string>

Unique identifier

default_layout_idFilter<string>

Identifier of the layout that is used for new candidates by default

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

deleted_atFilter<string>

Deletion timestamp

activeFilter<string>

allowed_sendersFilter<string>

List of email addresses that are allowed to send CV's to the organizations inbox. Email addresses can be partial (e.g., *@example.com)

avatarFilter<string>

Avatar image representing the organization

creditFilter<string>

Amount of credit currently available

delete_candidates_afterFilter<string>

Time in days after which candidates are automatically deleted

ftsFilter<string>

nameFilter<string>

Name of the organization

slugFilter<string>

Unique string. Used to determine the organization's email inbox address

typeFilter<string>

Type of the organization

Responses

200

A list of organizations with the selected columns

206

Partial Content

GET /organizations

curl -X GET "https://www.cv-transformer.com/api/v1/organizations?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update organizations

Filters

idFilter<string>

Unique identifier

default_layout_idFilter<string>

Identifier of the layout that is used for new candidates by default

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

deleted_atFilter<string>

Deletion timestamp

activeFilter<string>

allowed_sendersFilter<string>

List of email addresses that are allowed to send CV's to the organizations inbox. Email addresses can be partial (e.g., *@example.com)

avatarFilter<string>

Avatar image representing the organization

creditFilter<string>

Amount of credit currently available

delete_candidates_afterFilter<string>

Time in days after which candidates are automatically deleted

ftsFilter<string>

nameFilter<string>

Name of the organization

slugFilter<string>

Unique string. Used to determine the organization's email inbox address

typeFilter<string>

Type of the organization

Body

Partial<Organization>

Responses

204

The updated organizations with the selected columns

PATCH /organizations

curl -X PATCH "https://www.cv-transformer.com/api/v1/organizations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'

Webhook notifications

Endpoints

GET/webhook_notifications

The webhook notification object

Attributes

iduuid

Unique identifier

webhook_iduuid

webhooks.id

Identifier of the webhook this notification is related to

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

event_typetext

Event this notification is for

payloadjsonb

JSON payload that is sent along with this notification

responsetext | null

Stored response

statustext

Notification status. Either pending, sent or error

triesinteger

Amount of times this webhook notification has been tried to be delivered

The webhook notification object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "webhook_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.560Z",
  "updated_at": "2025-01-22T23:11:50.560Z",
  "event_type": "",
  "payload": {},
  "response": "",
  "status": "pending",
  "tries": 0
}

List webhook notifications

Filters

idFilter<string>

Unique identifier

webhook_idFilter<string>

Identifier of the webhook this notification is related to

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

event_typeFilter<string>

Event this notification is for

payloadFilter<string>

JSON payload that is sent along with this notification

responseFilter<string>

Stored response

statusFilter<string>

Notification status. Either pending, sent or error

triesFilter<string>

Amount of times this webhook notification has been tried to be delivered

Responses

200

A list of webhook notifications with the selected columns

206

Partial Content

GET /webhook_notifications

curl -X GET "https://www.cv-transformer.com/api/v1/webhook_notifications?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Webhooks

Endpoints

GET/webhooksPOST/webhooksDELETE/webhooksPATCH/webhooks

The webhook object

Attributes

iduuid

Unique identifier

organization_iduuid

organizations.id

Identifier of the organization this webhook is defined in

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

descriptiontext

An optional description of the webhook

endpointtext

URL to which notifications should be sent

eventstext[]

Events to which the webhook is subscribed. For possible values, see a complete list

signing_secrettext

String used to sign each notification send to the webhook. Used to verify the validity of the webhook notifications.

sourcetext

From where the webhook is registered. Can be from the admin, via the API, or via an external tool such as Zapier.

The webhook object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-22T23:11:50.596Z",
  "updated_at": "2025-01-22T23:11:50.596Z",
  "description": "",
  "endpoint": "",
  "events": [
    ""
  ],
  "signing_secret": "md5((random())::text)",
  "source": ""
}

List webhooks

Filters

idFilter<string>

Unique identifier

organization_idFilter<string>

Identifier of the organization this webhook is defined in

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

descriptionFilter<string>

An optional description of the webhook

endpointFilter<string>

URL to which notifications should be sent

eventsFilter<string>

Events to which the webhook is subscribed. For possible values, see a complete list

signing_secretFilter<string>

String used to sign each notification send to the webhook. Used to verify the validity of the webhook notifications.

sourceFilter<string>

From where the webhook is registered. Can be from the admin, via the API, or via an external tool such as Zapier.

Responses

200

A list of webhooks with the selected columns

206

Partial Content

GET /webhooks

curl -X GET "https://www.cv-transformer.com/api/v1/webhooks?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create webhooks

Body

Partial<Webhook>
 | Array<Partial<Webhook>>

Responses

201

The newly created webhooks with the selected columns

POST /webhooks

curl -X POST "https://www.cv-transformer.com/api/v1/webhooks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[]'

Delete webhooks

Filters

idFilter<string>

Unique identifier

organization_idFilter<string>

Identifier of the organization this webhook is defined in

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

descriptionFilter<string>

An optional description of the webhook

endpointFilter<string>

URL to which notifications should be sent

eventsFilter<string>

Events to which the webhook is subscribed. For possible values, see a complete list

signing_secretFilter<string>

String used to sign each notification send to the webhook. Used to verify the validity of the webhook notifications.

sourceFilter<string>

From where the webhook is registered. Can be from the admin, via the API, or via an external tool such as Zapier.

Responses

204

The deleted webhooks with the selected columns

DELETE /webhooks

curl -X DELETE "https://www.cv-transformer.com/api/v1/webhooks" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update webhooks

Filters

idFilter<string>

Unique identifier

organization_idFilter<string>

Identifier of the organization this webhook is defined in

created_atFilter<string>

Creation timestamp

updated_atFilter<string>

Last modification timestamp

descriptionFilter<string>

An optional description of the webhook

endpointFilter<string>

URL to which notifications should be sent

eventsFilter<string>

Events to which the webhook is subscribed. For possible values, see a complete list

signing_secretFilter<string>

String used to sign each notification send to the webhook. Used to verify the validity of the webhook notifications.

sourceFilter<string>

From where the webhook is registered. Can be from the admin, via the API, or via an external tool such as Zapier.

Body

Partial<Webhook>

Responses

204

The updated webhooks with the selected columns

PATCH /webhooks

curl -X PATCH "https://www.cv-transformer.com/api/v1/webhooks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'