Candidates

Identifier of the related layout

member_iduuid | null

Identifier of the member responsible for the candidate, initially its creator

organization_iduuid

Identifier of the related organization

created_atread-onlytimestamp with time zone

Creation timestamp

updated_atread-onlytimestamp with time zone

Last modification timestamp

deleted_attimestamp with time zone | null

Deletion timestamp

attachmentsRecord<string, CandidateAttachment>

Files attached to the candidate, such as CVs and vacancies

avatartext | null

Avatar image of the candidate. Filled automatically when the candidate is edited in the app

export_filenametext

Filename of exported PDF files (without .pdf). When empty, the layout's export_filename applies

external_dataCandidateExternalData | null

Data imported from an external source, such as an ATS

ftsread-onlytsvector

Full text search index

languageLanguage

Language in which the candidate is displayed

messagesArray<CandidateMessage>

Messages exchanged with the AI about the candidate

nametext

Name of the candidate, used for search. Filled automatically when the candidate is edited in the app

secretread-onlytext

Secret string. Used to share the candidate's proposal privately, with personal information

secret_anonymousread-onlytext

Secret string. Used to share the candidate's proposal privately, with personal information redacted

secret_editableread-onlytext

Secret string. Used to share the candidate for editing

section_attachmentsRecord<string, Array<SectionAttachment>>

Attachments shown in each attachment section, by section

statusread-onlyCandidateStatus

Status of the candidate. Only active candidates can be shared

valuesJsonObject

Values of the variables defined in the candidate's layout

Embed related resources in the response with the select parameter, for example select=*,layouts(*). See selecting data. Resources related through more than one column need the column as a hint, like table!column(*).

layouts(*)object | null

The layout referenced by layout_id.

members(*)object | null

The member referenced by member_id.

organizations!organization_id(*)object | null

candidate_analytics.candidate_id

The organization referenced by organization_id.

candidate_analytics(*)array

The candidate analytics referencing this candidate through candidate_analytics.candidate_id.

candidate_views(*)array

candidate_views.candidate_id

The candidate views referencing this candidate through candidate_views.candidate_id.

The candidate object

JSON

{
  "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:35:51.285Z",
      "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"
      }
    ]
  }
}

Including related resources

curl "https://api.cv-transformer.com/v1/candidates?limit=10&select=*,layouts(*),members(*)" \
  -H "Authorization: Bearer YOUR_API_KEY"

List candidates

Requirescandidates:read

Filters

idFilter<uuid>

Unique identifier

layout_idFilter<uuid | null>

Identifier of the related layout

member_idFilter<uuid | null>

Identifier of the member responsible for the candidate, initially its creator

organization_idFilter<uuid>

Identifier of the related organization

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

deleted_atFilter<timestamp with time zone | null>

Deletion timestamp

attachmentsFilter<Record<string, CandidateAttachment>>

Files attached to the candidate, such as CVs and vacancies

avatarFilter<text | null>

Avatar image of the candidate. Filled automatically when the candidate is edited in the app

export_filenameFilter<text>

Filename of exported PDF files (without .pdf). When empty, the layout's export_filename applies

external_dataFilter<CandidateExternalData | null>

Data imported from an external source, such as an ATS

ftsFilter<tsvector>

Full text search index

languageFilter<Language>

Language in which the candidate is displayed

messagesFilter<Array<CandidateMessage>>

Messages exchanged with the AI about the candidate

nameFilter<text>

Name of the candidate, used for search. Filled automatically when the candidate is edited in the app

secretFilter<text>

Secret string. Used to share the candidate's proposal privately, with personal information

secret_anonymousFilter<text>

Secret string. Used to share the candidate's proposal privately, with personal information redacted

secret_editableFilter<text>

Secret string. Used to share the candidate for editing

section_attachmentsFilter<Record<string, Array<SectionAttachment>>>

Attachments shown in each attachment section, by section

statusFilter<CandidateStatus>

Status of the candidate. Only active candidates can be shared

valuesFilter<JsonObject>

Values of the variables defined in the candidate's layout

Responses

200

A list of candidates with the selected columns. The Content-Range header holds the range returned and the total count, like 0-9/42.

206

Partial Content

400

The request is malformed, for example an unknown column or an invalid filter.

401

The API key is missing or invalid.

403

The API key doesn't have the scope this request needs.

429

The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the Retry-After header.

Errors have a JSON body with a message, details and hint, and for database errors a code. See errors.

GET/candidates

curl "https://api.cv-transformer.com/v1/candidates?limit=10&select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

JSON

[
  {
    "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:35:51.285Z",
        "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"
        }
      ]
    }
  }
]

Delete candidates

Requirescandidates:write

Filters

Without filters, this request deletes all candidates the API key has access to. Always filter on at least one column, like id=eq.{id}.

idFilter<uuid>

Unique identifier

layout_idFilter<uuid | null>

Identifier of the related layout

member_idFilter<uuid | null>

Identifier of the member responsible for the candidate, initially its creator

organization_idFilter<uuid>

Identifier of the related organization

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

deleted_atFilter<timestamp with time zone | null>

Deletion timestamp

attachmentsFilter<Record<string, CandidateAttachment>>

Files attached to the candidate, such as CVs and vacancies

avatarFilter<text | null>

Avatar image of the candidate. Filled automatically when the candidate is edited in the app

export_filenameFilter<text>

Filename of exported PDF files (without .pdf). When empty, the layout's export_filename applies

external_dataFilter<CandidateExternalData | null>

Data imported from an external source, such as an ATS

ftsFilter<tsvector>

Full text search index

languageFilter<Language>

Language in which the candidate is displayed

messagesFilter<Array<CandidateMessage>>

Messages exchanged with the AI about the candidate

nameFilter<text>

Name of the candidate, used for search. Filled automatically when the candidate is edited in the app

secretFilter<text>

Secret string. Used to share the candidate's proposal privately, with personal information

secret_anonymousFilter<text>

Secret string. Used to share the candidate's proposal privately, with personal information redacted

secret_editableFilter<text>

Secret string. Used to share the candidate for editing

section_attachmentsFilter<Record<string, Array<SectionAttachment>>>

Attachments shown in each attachment section, by section

statusFilter<CandidateStatus>

Status of the candidate. Only active candidates can be shared

valuesFilter<JsonObject>

Values of the variables defined in the candidate's layout

Responses

204

Deleted. With the header Prefer: return=representation, the response is a 200 whose body holds the deleted candidates with the selected columns.

400

The request is malformed, for example an unknown column or an invalid filter.

401

The API key is missing or invalid.

403

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.

429

The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the Retry-After header.

Errors have a JSON body with a message, details and hint, and for database errors a code. See errors.

DELETE/candidates

curl -X DELETE "https://api.cv-transformer.com/v1/candidates?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

JSON

(no content)

Update candidates

Requirescandidates:write

Filters

Without filters, this request updates all candidates the API key has access to. Always filter on at least one column, like id=eq.{id}.

idFilter<uuid>

Unique identifier

layout_idFilter<uuid | null>

Identifier of the related layout

member_idFilter<uuid | null>

Identifier of the member responsible for the candidate, initially its creator

organization_idFilter<uuid>