Organizations

Organizations and their settings

Endpoints

GET/organizationsPATCH/organizations

The organization object

Attributes

idread-onlyuuid

Unique identifier

billing_account_idread-onlyuuid

billing_accounts.id

Identifier of the billing account this organization belongs to

bullhorn_corporation_idread-onlytext | null

Identifier of the organization's corporation in Bullhorn

bullhorn_private_label_idread-onlyinteger | null

Identifier of the organization's private label in Bullhorn, used to match Bullhorn users to the organization

default_layout_iduuid | null

layouts.id

Identifier of the layout new candidates use by default

created_atread-onlytimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

deleted_atread-onlytimestamp with time zone | null

Deletion timestamp

active_ats_integrationIntegrationName | null

ATS integration that is currently active

allow_inspectionboolean

Whether the CV-Transformer team is allowed to inspect the organization to debug errors

allow_word_outputboolean

Whether Word output is enabled for the organization

allowed_senderstext[]

Email addresses allowed to send CVs to the organization's inbox. Can be partial, like *@example.com

atstext

The ATS this organization uses

avatartext | null

Avatar image of the organization

carerix_attachment_node_typetext | null

Identifier of the Carerix attachment type that exported files get

carerix_entity_kind"CREmployee" | "CRMatch"

Carerix entity that candidates are linked to: a candidate (CREmployee) or a match (CRMatch)

default_prompttext

Default prompt for filling in candidates

delete_candidates_afterinteger | null

Number of days after which candidates are deleted automatically

detect_candidate_language_from_attachmentboolean

Whether a candidate's language is detected from its first uploaded attachment

enable_beta_integrationsread-onlyboolean

Whether integrations in beta are available to the organization

enable_data_tabread-onlyboolean

external_variablesArray<LayoutVariable>

Variables of the data imported from the external integration

ftsread-onlytsvector

Full text search index

member_variablesArray<MemberVariable>

Variables defined on each member, usable in layouts

modeltext

AI model the organization uses

nametext

Name of the organization

proposal_byProposalAuthor

Author shown on web proposals

proposal_reactionsArray<ProposalReaction>

Reactions allowed on proposals

require_mfaread-onlyboolean

Whether MFA is required for members to access this organization

salesforce_instance_urlread-onlytext | null

URL of the organization's Salesforce instance

seven20_export_make_primary_cv_when_emptyboolean

Whether an export to Seven20 makes the CV primary when the candidate has no primary CV

slugtext

Unique string. The organization's candidate inbox is {{slug}}@candidates.cv-transformer.com

statusread-onlyOrganizationStatus

Internal status of the organization

typeread-onlyOrganizationType | null

Type of the organization

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

billing_accounts!billing_account_id(*)object | null

billing_accounts.id

The billing account referenced by billing_account_id.

layouts!default_layout_id(*)object | null

layouts.id

The layout referenced by default_layout_id.

candidate_analytics(*)array

candidate_analytics.organization_id

The candidate analytics referencing this organization through candidate_analytics.organization_id.

candidates!organization_id(*)array

candidates.organization_id

The candidates referencing this organization through candidates.organization_id.

credit_mutations(*)array

credit_mutations.organization_id

The credit mutations referencing this organization through credit_mutations.organization_id.

layouts!organization_id(*)array

layouts.organization_id

The layouts referencing this organization through layouts.organization_id.

members!organization_id(*)array

members.organization_id

The members referencing this organization through members.organization_id.

webhooks(*)array

webhooks.organization_id

The webhooks referencing this organization through webhooks.organization_id.

The organization object

JSON

{
  "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"
}

Including related resources

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

List organizations

Requiresorganization:read

Filters

idFilter<uuid>

Unique identifier

billing_account_idFilter<uuid>

billing_accounts.id

Identifier of the billing account this organization belongs to

bullhorn_corporation_idFilter<text | null>

Identifier of the organization's corporation in Bullhorn

bullhorn_private_label_idFilter<integer | null>

Identifier of the organization's private label in Bullhorn, used to match Bullhorn users to the organization

default_layout_idFilter<uuid | null>

layouts.id

Identifier of the layout new candidates use by default

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

active_ats_integrationFilter<IntegrationName | null>

ATS integration that is currently active

allow_inspectionFilter<boolean>

Whether the CV-Transformer team is allowed to inspect the organization to debug errors

allow_word_outputFilter<boolean>

Whether Word output is enabled for the organization

allowed_sendersFilter<text[]>

Email addresses allowed to send CVs to the organization's inbox. Can be partial, like *@example.com

atsFilter<text>

The ATS this organization uses

avatarFilter<text | null>

Avatar image of the organization

carerix_attachment_node_typeFilter<text | null>

Identifier of the Carerix attachment type that exported files get

carerix_entity_kindFilter<"CREmployee" | "CRMatch">

Carerix entity that candidates are linked to: a candidate (CREmployee) or a match (CRMatch)

default_promptFilter<text>

Default prompt for filling in candidates

delete_candidates_afterFilter<integer | null>

Number of days after which candidates are deleted automatically

detect_candidate_language_from_attachmentFilter<boolean>

Whether a candidate's language is detected from its first uploaded attachment

enable_beta_integrationsFilter<boolean>

Whether integrations in beta are available to the organization

enable_data_tabFilter<boolean>

external_variablesFilter<Array<LayoutVariable>>

Variables of the data imported from the external integration

ftsFilter<tsvector>

Full text search index

member_variablesFilter<Array<MemberVariable>>

Variables defined on each member, usable in layouts

modelFilter<text>

AI model the organization uses

nameFilter<text>

Name of the organization

proposal_byFilter<ProposalAuthor>

Author shown on web proposals

proposal_reactionsFilter<Array<ProposalReaction>>

Reactions allowed on proposals

require_mfaFilter<boolean>

Whether MFA is required for members to access this organization

salesforce_instance_urlFilter<text | null>

URL of the organization's Salesforce instance

seven20_export_make_primary_cv_when_emptyFilter<boolean>

Whether an export to Seven20 makes the CV primary when the candidate has no primary CV

slugFilter<text>

Unique string. The organization's candidate inbox is {{slug}}@candidates.cv-transformer.com

statusFilter<OrganizationStatus>

Internal status of the organization

typeFilter<OrganizationType | null>

Type of the organization

Responses

200

A list of organizations 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/organizations

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

Example response

JSON

[
  {
    "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"
  }
]

Update organizations

Requiresorganization:write

Filters

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

idFilter<uuid>

Unique identifier

billing_account_idFilter<uuid>

billing_accounts.id

Identifier of the billing account this organization belongs to

bullhorn_corporation_idFilter<text | null>

Identifier of the organization's corporation in Bullhorn

bullhorn_private_label_idFilter<integer | null>

Identifier of the organization's private label in Bullhorn, used to match Bullhorn users to the organization

default_layout_idFilter<uuid | null>

layouts.id

Identifier of the layout new candidates use by default

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

active_ats_integrationFilter<IntegrationName | null>

ATS integration that is currently active

allow_inspectionFilter<boolean>

Whether the CV-Transformer team is allowed to inspect the organization to debug errors

allow_word_outputFilter<boolean>

Whether Word output is enabled for the organization

allowed_sendersFilter<text[]>

Email addresses allowed to send CVs to the organization's inbox. Can be partial, like *@example.com

atsFilter<text>

The ATS this organization uses

avatarFilter<text | null>

Avatar image of the organization

carerix_attachment_node_typeFilter<text | null>

Identifier of the Carerix attachment type that exported files get

carerix_entity_kindFilter<"CREmployee" | "CRMatch">

Carerix entity that candidates are linked to: a candidate (CREmployee) or a match (CRMatch)

default_promptFilter<text>

Default prompt for filling in candidates

delete_candidates_afterFilter<integer | null>

Number of days after which candidates are deleted automatically

detect_candidate_language_from_attachmentFilter<boolean>

Whether a candidate's language is detected from its first uploaded attachment

enable_beta_integrationsFilter<boolean>

Whether integrations in beta are available to the organization

enable_data_tabFilter<boolean>

external_variablesFilter<Array<LayoutVariable>>

Variables of the data imported from the external integration

ftsFilter<tsvector>

Full text search index

member_variablesFilter<Array<MemberVariable>>

Variables defined on each member, usable in layouts

modelFilter<text>

AI model the organization uses

nameFilter<text>

Name of the organization

proposal_byFilter<ProposalAuthor>

Author shown on web proposals

proposal_reactionsFilter<Array<ProposalReaction>>

Reactions allowed on proposals

require_mfaFilter<boolean>

Whether MFA is required for members to access this organization

salesforce_instance_urlFilter<text | null>

URL of the organization's Salesforce instance

seven20_export_make_primary_cv_when_emptyFilter<boolean>

Whether an export to Seven20 makes the CV primary when the candidate has no primary CV

slugFilter<text>

Unique string. The organization's candidate inbox is {{slug}}@candidates.cv-transformer.com

statusFilter<OrganizationStatus>

Internal status of the organization

typeFilter<OrganizationType | null>

Type of the organization

Body

Partial<Organization>

The attributes are listed under the organization object. Read-only attributes are set by CV-Transformer and can't be written.

Responses

204

Updated. With the header Prefer: return=representation, the response is a 200 whose body holds the updated organizations with the selected columns.

400

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

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.

409

The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.

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.

PATCH/organizations

curl -X PATCH "https://api.cv-transformer.com/v1/organizations?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "allow_inspection": false }'

Example response

JSON

(no content)

Organizations

The organization object#

Attributes

Related resources#

List organizations#

Filters

Responses

Update organizations#

Filters

Body

Responses

The organization object

Related resources

List organizations

Update organizations