Skip to content
RecruitiFi Partner API

Get Settings Link

GET
/v1/links/settings

Returns a signed URL where the client user can view and edit their organization settings within RecruitiFi.

Authorizations

Parameters

Query Parameters

connectorId
required
string

The connector identifier for the integration.

Example
con_abc123
clientId
required
string

The client identifier within the partner system.

Example
cli_xyz789
userId
required
string

The user identifier within the partner system.

Example
usr_456def

Responses

200

Signed URL generated successfully.

object
url
required

The signed URL to embed in an iframe. This URL is time-limited and should not be cached long-term.

string format: uri
expiresAt
required

ISO 8601 timestamp indicating when the signed URL expires.

string format: date-time
Example
{
  "url": "https://app.recruitifi.com/embed/settings?token=eyJhbGciOi...",
  "expiresAt": "2025-01-15T12:30:00Z"
}

401

Unauthorized — missing or invalid X-Auth-Token.

object
error
required

Machine-readable error code.

string
message
required

Human-readable error description.

string
Example
{
  "error": "unauthorized",
  "message": "Missing or invalid X-Auth-Token header."
}

403

Forbidden — token is valid but lacks sufficient permissions.

object
error
required

Machine-readable error code.

string
message
required

Human-readable error description.

string
Example
{
  "error": "forbidden",
  "message": "You do not have permission to access this resource."
}

422

Unprocessable Entity — missing or invalid query parameters.

object
error
required

Machine-readable error code.

string
message
required

Human-readable error description.

string
Example
{
  "error": "unprocessable_entity",
  "message": "One or more required query parameters are missing or invalid."
}