Ctrlk
HomeStatusSign in ->
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Users

The Users API enables businesses to programmatically retrieve and manage members within their organization, including paginated user listings and detailed individual profiles with role and activity data.

List users in the organization

get

Returns a paginated list of users belonging to the organization. Requires can_manage_users permission.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Query parameters
pageintegerOptional

Page number (0-based)

Default: 0
sizeintegerOptional

Page size (default 20)

Default: 20
Header parameters
AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Responses
200

200

application/json;charset=UTF-8
get/organizations/users
GET /organizations/users HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

{
  "content": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "email": "user@example.com",
      "idpId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "profile": {
        "id": "d4e5f6a7-b8c9-0123-def0-123456789012",
        "firstName": "Jan",
        "lastName": "Kowalski",
        "title": "Developer",
        "organizationId": "e5f6a7b8-c9d0-1234-ef01-234567890123",
        "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "status": "ACTIVE",
        "createdDateTime": "2025-01-01T10:00:00Z",
        "lastSignedInAt": "2025-06-01T08:00:00Z"
      },
      "createdDateTime": "2025-01-01T10:00:00Z"
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 20,
  "number": 0
}

Get user details

get

Returns details of a single user in the organization. Requires can_manage_users permission.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
userIdstring · uuidRequired

Identifier of the user

Header parameters
AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Responses
200

200

application/json;charset=UTF-8
get/organizations/users/{userId}
GET /organizations/users/{userId} HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "user@example.com",
  "idpId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "profile": {
    "id": "d4e5f6a7-b8c9-0123-def0-123456789012",
    "firstName": "Jan",
    "lastName": "Kowalski",
    "title": "Developer",
    "organizationId": "e5f6a7b8-c9d0-1234-ef01-234567890123",
    "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "status": "ACTIVE",
    "createdDateTime": "2025-01-01T10:00:00Z",
    "lastSignedInAt": "2025-06-01T08:00:00Z"
  },
  "createdDateTime": "2025-01-01T10:00:00Z"
}

Update user profile

put

Updates the profile (first name, last name, title) of a user. Requires can_manage_users permission.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
userIdstring · uuidRequired

Identifier of the user

Header parameters
AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Body
firstNamestring · nullableOptional

First name of the user

lastNamestring · nullableOptional

Last name of the user

titlestring · nullableOptional

Job title of the user

Responses
200

200

application/json;charset=UTF-8
put/organizations/users/{userId}/profile
PUT /organizations/users/{userId}/profile HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "firstName": "Jan",
  "lastName": "Nowak",
  "title": "Senior Developer"
}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "user@example.com",
  "idpId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "profile": {
    "id": "d4e5f6a7-b8c9-0123-def0-123456789012",
    "firstName": "Jan",
    "lastName": "Nowak",
    "title": "Senior Developer",
    "organizationId": "e5f6a7b8-c9d0-1234-ef01-234567890123",
    "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "status": "ACTIVE",
    "createdDateTime": "2025-01-01T10:00:00Z",
    "lastSignedInAt": "2025-06-01T08:00:00Z"
  },
  "createdDateTime": "2025-01-01T10:00:00Z"
}

Update user role in organization

put

Updates the organization-level role assigned to a user. Requires can_manage_users permission.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
userIdstring · uuidRequired

Identifier of the user

Header parameters
AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Body
roleIdstring · uuidRequired

Identifier of the new role to assign

Responses
200

200

application/json;charset=UTF-8
put/organizations/users/{userId}/role
PUT /organizations/users/{userId}/role HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "user@example.com",
  "idpId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "profile": {
    "id": "d4e5f6a7-b8c9-0123-def0-123456789012",
    "firstName": "Jan",
    "lastName": "Kowalski",
    "title": "Developer",
    "organizationId": "e5f6a7b8-c9d0-1234-ef01-234567890123",
    "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "status": "ACTIVE",
    "createdDateTime": "2025-01-01T10:00:00Z",
    "lastSignedInAt": "2025-06-01T08:00:00Z"
  },
  "createdDateTime": "2025-01-01T10:00:00Z"
}

Terminate user

post

Deactivates a user in the organization (sets status to TERMINATED). Requires can_manage_users permission.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
userIdstring · uuidRequired

Identifier of the user to terminate

Header parameters
AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Responses
200

200

application/json;charset=UTF-8
post/organizations/users/{userId}/terminate
POST /organizations/users/{userId}/terminate HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "user@example.com",
  "idpId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "profile": {
    "id": "d4e5f6a7-b8c9-0123-def0-123456789012",
    "firstName": "Jan",
    "lastName": "Kowalski",
    "title": "Developer",
    "organizationId": "e5f6a7b8-c9d0-1234-ef01-234567890123",
    "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "status": "TERMINATED",
    "createdDateTime": "2025-01-01T10:00:00Z",
    "lastSignedInAt": "2025-06-01T08:00:00Z"
  },
  "createdDateTime": "2025-01-01T10:00:00Z"
}

Reinstate user

post

Reinstates a previously terminated user in the organization. Requires can_manage_users permission.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
userIdstring · uuidRequired

Identifier of the user to reinstate

Header parameters
AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Body
roleIdstring · uuidRequired

Identifier of the role to assign upon reinstatement

Responses
200

200

application/json;charset=UTF-8
post/organizations/users/{userId}/reinstate
POST /organizations/users/{userId}/reinstate HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "user@example.com",
  "idpId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "profile": {
    "id": "d4e5f6a7-b8c9-0123-def0-123456789012",
    "firstName": "Jan",
    "lastName": "Kowalski",
    "title": "Developer",
    "organizationId": "e5f6a7b8-c9d0-1234-ef01-234567890123",
    "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "status": "ACTIVE",
    "createdDateTime": "2025-01-01T10:00:00Z",
    "lastSignedInAt": null
  },
  "createdDateTime": "2025-01-01T10:00:00Z"
}

Reset MFA for a user

post

Resets multi-factor authentication for the specified user. Requires can_reset_2fa permission on the organization.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
userIdstring · uuidRequired

Identifier of the user whose MFA should be reset

Header parameters
AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Responses
202

Accepted – MFA reset request accepted

No content
post/organizations/users/{userId}/reset-mfa
POST /organizations/users/{userId}/reset-mfa HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

No content
PreviousComments
NextEnrollments

Last updated