BlackLine

App · 25 actions

Work with your BlackLine financial close: users and teams, journal entries, reports, data imports, Transaction Matching and the audit trail, and start workflows when journals, imports, reports or periods change.

Actions

ActionWhat it does
Add journal commentAdd a comment to a journal entry, as the connected user.
Add user to teamsAdd a BlackLine user to one or more teams.
Create teamCreate a BlackLine team, at the top of the hierarchy or under another team.
Create userAdd a user to BlackLine.
Delete journal commentDelete a comment from a journal entry.
Delete teamDelete a BlackLine team.
Deprovision userStart BlackLine's deprovisioning of a user: it disables them and takes away their access and assignments, and finishes in the background.
Export report runStart exporting a finished report run to a CSV, Excel or PDF file.
Get current userGet the BlackLine user the connection signs in as, with their default role.
Get journalGet one journal entry with its status, who prepared and approved it, who is assigned, and how many lines, comments and documents it has.
Get report exportCheck a report export and, once it is complete, get a link to download the file.
Get teamGet one BlackLine team.
Get userGet one BlackLine user, optionally with their teams, entities, roles and products, or preferences.
List audit trailList BlackLine's audit trail, newest first: who changed what, in which area, with the value before and after.
List data importsList the data imports (account balances, items, users and the like) started in a time window, with whether each succeeded and how many rows it added, changed or failed.
List entitiesList the entities in BlackLine's master data (companies, regions, departments) with their codes and parents.
List journalsList the journal entries in a period that a role can see, with their posting status, date and preparer, filtered by team, preparer, documents or posting date.
List match setsList Transaction Matching match sets with their data sources.
List periodsList BlackLine's accounting periods with their end dates and whether each is current or closed, or only the current one.
List report runsList the reports the connected user has run in BlackLine, with their status, times and export links.
List teamsList BlackLine teams with their codes and where they sit in the team hierarchy, optionally by name.
List usersList BlackLine users with their login, email, status and default role, optionally by login, email or role.
Remove user from teamTake a BlackLine user off one team.
Run matchingRun Transaction Matching's engine on one or more match sets, now or at a set time, to match their transactions by their pass rules.
Update userChange a BlackLine user's details, such as their email, job title or whether they can sign in.

Add journal comment

Add a comment to a journal entry, as the connected user.

Inputs

Journal IDjournal_idtextRequired
The journal's id, from 'List journals' or a trigger.
CommentcommenttextRequired
The comment to add.
Rolerole_idtext
The BlackLine role to act in, such as Preparer: the step sees and does what that role may. Leave empty for the connected user's default role.

Outputs

commentobject
The comment added
Example output
{
  "comment": {
    "comment": "Supporting invoice attached in the shared drive.",
    "date": "2026-11-13T09:00:00Z",
    "id": 9001,
    "isTemporary": false,
    "submittedBy": "Jane Doe",
    "submittedById": 1042
  }
}

Add user to teams

Add a BlackLine user to one or more teams. They stay on any team they are already on.

Inputs

UserusertextRequired
The BlackLine user. Pick one, or give their id.
Teamsteam_idslistRequired
The teams to add them to.

Outputs

assignedtrue/false
True once BlackLine accepted it
team_idslist
The teams they were added to
user_idnumber
The user's id
Example output
{
  "assigned": true,
  "team_ids": [
    77
  ],
  "user_id": 1042
}

Create team

Create a BlackLine team, at the top of the hierarchy or under another team.

Inputs

NamenametextRequired
The team's name.
Unique codeunique_codetextRequired
A code no other team has, such as AP-EAST.
Parent teamparent_team_idtext
The team to put it under. Leave empty for the top.

Outputs

teamobject
The team
Example output
{
  "team": {
    "id": 77,
    "level": 2,
    "name": "Accounts Payable East",
    "parentId": 12,
    "uniqueCode": "AP-EAST"
  }
}

Create user

Add a user to BlackLine. They start inactive unless Active is on; give them roles and entities in BlackLine before they sign in.

Inputs

Loginlogin_idtextRequired
The name they sign in to BlackLine with, such as jane.doe.
First namefirst_nametextRequired
Their first name.
Last namelast_nametextRequired
Their last name.
EmailemailtextRequired
Their email address.
Time zonetime_zone_idtextRequired
Their time zone.
Activeis_activetrue/false
Turn on to let them sign in. BlackLine may refuse to make a user active before they have an entity, so new users start inactive.
Job titlejob_titletext
Their job title.
Phone numberphone_numbertext
Their phone number.
Supervisorsupervisortext
Their supervisor's name.
Annual hoursannual_hoursnumber
The hours they work in a year, such as 2000.From 0 to 8784.
Reference field 1reference_field_1text
Your own reference value.
Reference field 2reference_field_2text
Your own reference value.
Reference field 3reference_field_3text
Your own reference value.

Outputs

userobject
The user
Example output
{
  "user": {
    "annualHours": 2000,
    "created": "2026-01-05T14:00:00",
    "defaultRoleId": 1,
    "email": "jane.doe@example.com",
    "firstName": "Jane",
    "fullName": "Jane Doe",
    "id": 1042,
    "isActive": false,
    "jobTitle": "Senior Accountant",
    "lastName": "Doe",
    "lastUpdated": "2026-10-01T09:30:00",
    "loginId": "jane.doe",
    "phoneNumber": "(555) 555-1234",
    "referenceField1": "GL-East",
    "referenceField2": "",
    "referenceField3": "",
    "supervisor": "Sam Lee",
    "timeZoneId": 3
  }
}

Delete journal comment

Delete a comment from a journal entry.

Inputs

Journal IDjournal_idtextRequired
The journal's id, from 'List journals' or a trigger.
Comment IDcomment_idtextRequired
The comment's id, from 'Add journal comment'.
Rolerole_idtext
The BlackLine role to act in, such as Preparer: the step sees and does what that role may. Leave empty for the connected user's default role.

Outputs

comment_idnumber
The deleted comment's id
deletedtrue/false
True once BlackLine deleted it
journal_idnumber
The journal's id
Example output
{
  "comment_id": 9001,
  "deleted": true,
  "journal_id": 5501
}

Delete team

Delete a BlackLine team.

Inputs

TeamteamtextRequired
The team. Pick one, or give its id.

Outputs

deletedtrue/false
True once BlackLine deleted it
team_idnumber
The deleted team's id
Example output
{
  "deleted": true,
  "team_id": 77
}

Deprovision user

Start BlackLine's deprovisioning of a user: it disables them and takes away their access and assignments, and finishes in the background.

Inputs

UserusertextRequired
The BlackLine user. Pick one, or give their id.

Outputs

deprovisionobject
Where the deprovisioning is
Example output
{
  "deprovision": {
    "correlationId": "5f0c6c1e-8a51-4d3b-9b8e-1f3f1c2d4e5a",
    "estimatedCompletion": "2026-11-13",
    "isCompleted": false,
    "isSuccess": false,
    "lastUpdateAt": "2026-11-13",
    "requestedAt": "2026-11-13",
    "status": "Queued",
    "userId": 1042
  }
}

Export report run

Start exporting a finished report run to a CSV, Excel or PDF file. Use 'Get report export' with the export id to get the file's link.

Inputs

Report runreport_run_idtextRequired
The report run to export.
File typeexport_typetext
The kind of file. Defaults to CSV.One of: CSV, Excel, ExcelSummary (Excel summary), PDF. Default: CSV.

Outputs

export_typetext
The file type
report_export_idnumber
The export's id, for 'Get report export'
report_run_idnumber
The report run exported
status_urltext
BlackLine's address for the export's status
Example output
{
  "export_type": "CSV",
  "report_export_id": 2379,
  "report_run_id": 3301,
  "status_url": "https://us.api.blackline.com/v3/reporting/report-exports/2379/status"
}

Get current user

Get the BlackLine user the connection signs in as, with their default role.

Inputs

None.

Outputs

userobject
The user
Example output
{
  "user": {
    "annualHours": 2000,
    "created": "2026-01-05T14:00:00",
    "defaultRoleId": 1,
    "email": "jane.doe@example.com",
    "firstName": "Jane",
    "fullName": "Jane Doe",
    "id": 1042,
    "isActive": true,
    "jobTitle": "Senior Accountant",
    "lastName": "Doe",
    "lastUpdated": "2026-10-01T09:30:00",
    "loginId": "jane.doe",
    "phoneNumber": "(555) 555-1234",
    "referenceField1": "GL-East",
    "referenceField2": "",
    "referenceField3": "",
    "supervisor": "Sam Lee",
    "timeZoneId": 3
  }
}

Get journal

Get one journal entry with its status, who prepared and approved it, who is assigned, and how many lines, comments and documents it has.

Inputs

Journal IDjournal_idtextRequired
The journal's id, from 'List journals' or a trigger.
Rolerole_idtext
The BlackLine role to act in, such as Preparer: the step sees and does what that role may. Leave empty for the connected user's default role.

Outputs

journalobject
The journal
Example output
{
  "journal": {
    "batchId": 0,
    "certificationStatus": [
      {
        "certStatusTypeName": "Prepared",
        "certificationDateTime": "2026-11-02T10:15:00Z",
        "fullName": "Jane Doe",
        "roleId": 1
      }
    ],
    "countOfComments": 1,
    "countOfDocuments": 0,
    "countOfLines": 4,
    "entityCode": "UK01",
    "finalCertificationState": "Prepared",
    "isBatch": false,
    "journalId": 5501,
    "purpose": "Accrue October utilities",
    "statusMessage": "",
    "statusName": "Prepared",
    "teamName": "Accounts Payable East",
    "templateId": 14,
    "title": "October accruals",
    "userAssignments": [
      {
        "fullName": "Jane Doe",
        "roleId": 1,
        "userId": 1042
      }
    ]
  }
}

Get report export

Check a report export and, once it is complete, get a link to download the file. The link works for an hour.

Inputs

Export IDreport_export_idtextRequired
The export's id, from 'Export report run'.

Outputs

download_urltext
The file's download link, once complete
expires_attext
When the link stops working
messagetext
What BlackLine said about the export
report_export_idnumber
The export's id
statustext
Pending, Processing, Complete or Failed
Example output
{
  "download_url": "https://storage.googleapis.com/blackline-exports/2379.csv?X-Goog-Signature=abc",
  "expires_at": "2026-11-13T10:00:00Z",
  "message": "",
  "report_export_id": 2379,
  "status": "Complete"
}

Get team

Get one BlackLine team.

Inputs

TeamteamtextRequired
The team. Pick one, or give its id.

Outputs

teamobject
The team
Example output
{
  "team": {
    "id": 77,
    "level": 2,
    "name": "Accounts Payable East",
    "parentId": 12,
    "uniqueCode": "AP-EAST"
  }
}

Get user

Get one BlackLine user, optionally with their teams, entities, roles and products, or preferences.

Inputs

UserusertextRequired
The BlackLine user. Pick one, or give their id.
Includeincludelist
What else to get about the user.One or more of: teams, entities, roles-products (Roles and products), preferences.

Outputs

userobject
The user
Example output
{
  "user": {
    "annualHours": 2000,
    "created": "2026-01-05T14:00:00",
    "defaultRoleId": 1,
    "email": "jane.doe@example.com",
    "entities": [
      {
        "id": "310",
        "levelId": "2",
        "lineage": "Acme Group > Europe",
        "name": "Acme UK Ltd",
        "numberOfChildren": 0,
        "parentId": "300",
        "sourceId": "UK01",
        "uniqueCode": "UK01"
      }
    ],
    "firstName": "Jane",
    "fullName": "Jane Doe",
    "id": 1042,
    "isActive": true,
    "jobTitle": "Senior Accountant",
    "lastName": "Doe",
    "lastUpdated": "2026-10-01T09:30:00",
    "loginId": "jane.doe",
    "phoneNumber": "(555) 555-1234",
    "referenceField1": "GL-East",
    "referenceField2": "",
    "referenceField3": "",
    "supervisor": "Sam Lee",
    "teams": [
      {
        "id": 77,
        "level": 2,
        "name": "Accounts Payable East",
        "parentId": 12,
        "uniqueCode": "AP-EAST"
      }
    ],
    "timeZoneId": 3
  }
}

List audit trail

List BlackLine's audit trail, newest first: who changed what, in which area, with the value before and after. Gets one page.

Inputs

Areaareatext
Only changes in this area of BlackLine, such as Accounts.
Ordersort_ordertext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Pagepagenumber
Which page to get, counted from 0 as BlackLine counts it. Leave empty for the first page.At least 0.
Page sizepage_sizenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records this page holds
entrieslist
The audit trail entries
items_per_pagenumber
The page size BlackLine used
page_start_indexnumber
Where this page starts, as BlackLine counts it
total_itemsnumber
How many records match in all
Example output
{
  "count": 1,
  "entries": [
    {
      "area": "Accounts",
      "changeDate": "2026-11-13T09:12:00Z",
      "changeMade": "Changed approver",
      "changeSetId": "c1a2b3",
      "newValue": "Jane Doe",
      "originalValue": "Sam Lee",
      "pkId": 1000,
      "recordChanged": "1000-Cash",
      "source": "User interface",
      "userId": 1042,
      "userName": "Jane Doe"
    }
  ],
  "items_per_page": 25,
  "page_start_index": 0,
  "total_items": 1
}

List data imports

List the data imports (account balances, items, users and the like) started in a time window, with whether each succeeded and how many rows it added, changed or failed. Covers the last 7 days unless given.

Inputs

Started afterstarted_afterdate and time
Only imports started at or after this time. Defaults to 7 days ago.
Started beforestarted_beforedate and time
Only imports started before this time. Defaults to now.
Ordersort_ordertext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Pagepagenumber
Which page to get, counted from 0 as BlackLine counts it. Leave empty for the first page.At least 0.
Page sizepage_sizenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records this page holds
importslist
The imports
items_per_pagenumber
The page size BlackLine used
page_start_indexnumber
Where this page starts, as BlackLine counts it
total_itemsnumber
How many records match in all
Example output
{
  "count": 1,
  "imports": [
    {
      "batchName": "Account balances",
      "id": "8f2b6d0e-4c1a-4b7e-9d33-2a6c5e7f8a90",
      "importSummary": {
        "deleted": 0,
        "failed": 0,
        "inserted": 1200,
        "total": 1250,
        "updated": 50
      },
      "jobEndTime": "2026-11-13T06:02:30Z",
      "jobStartTime": "2026-11-13T06:00:00Z",
      "message": "Imported 1,250 rows.",
      "processSteps": [
        {
          "message": "1,250 rows",
          "processName": "Load account balances",
          "status": "Completed",
          "statusSuccessful": true
        }
      ],
      "sourceFiles": [
        {
          "fileName": "balances_oct.csv",
          "fileUploadDate": "2026-11-13T05:59:00Z"
        }
      ],
      "status": "Completed",
      "statusSuccessful": true
    }
  ],
  "items_per_page": 25,
  "page_start_index": 0,
  "total_items": 1
}

List entities

List the entities in BlackLine's master data (companies, regions, departments) with their codes and parents. Gets one page.

Inputs

Pagepagenumber
Which page to get, counted from 0 as BlackLine counts it. Leave empty for the first page.At least 0.
Page sizepage_sizenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records this page holds
entitieslist
The entities
items_per_pagenumber
The page size BlackLine used
page_start_indexnumber
Where this page starts, as BlackLine counts it
total_itemsnumber
How many records match in all
Example output
{
  "count": 1,
  "entities": [
    {
      "id": "310",
      "levelId": "2",
      "lineage": "Acme Group > Europe",
      "name": "Acme UK Ltd",
      "numberOfChildren": 0,
      "parentId": "300",
      "sourceId": "UK01",
      "uniqueCode": "UK01"
    }
  ],
  "items_per_page": 25,
  "page_start_index": 0,
  "total_items": 1
}

List journals

List the journal entries in a period that a role can see, with their posting status, date and preparer, filtered by team, preparer, documents or posting date. Gets one page.

Inputs

Periodperiod_idtext
The period. Leave empty for the current period.
Rolerole_idtext
The BlackLine role to act in, such as Preparer: the step sees and does what that role may. Leave empty for the connected user's default role.
Teamteamtext
Only journals for this team.
Preparerpreparer_idtext
Only journals prepared by this user.
Only journals with documentshas_documentstrue/false
Turn on for only journals with documents attached.
Posting fromposting_date_fromdate and time
Only journals posting on or after this time.
Posting untilposting_date_todate and time
Only journals posting on or before this time.
Ordersort_ordertext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Pagepagenumber
Which page to get, counted from 0 as BlackLine counts it. Leave empty for the first page.At least 0.
Page sizepage_sizenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records this page holds
items_per_pagenumber
The page size BlackLine used
journalslist
The journals
page_start_indexnumber
Where this page starts, as BlackLine counts it
total_itemsnumber
How many records match in all
Example output
{
  "count": 1,
  "items_per_page": 25,
  "journals": [
    {
      "batchId": 0,
      "isBatch": false,
      "journalId": 5501,
      "postingDate": "2026-10-31T00:00:00",
      "postingStatusCode": "Ready",
      "postingStatusName": "Ready",
      "preparerName": "Jane Doe",
      "templateId": 14,
      "templateName": "Standard accrual",
      "title": "October accruals"
    }
  ],
  "page_start_index": 0,
  "total_items": 1
}

List match sets

List Transaction Matching match sets with their data sources. Gets one page.

Inputs

Typematch_set_typetext
Matching or intercompany match sets. Leave empty for both.One of: matching, intercompany.
Pagepagenumber
Which page to get, counted from 0 as BlackLine counts it. Leave empty for the first page.At least 0.
Page sizepage_sizenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records this page holds
items_per_pagenumber
The page size BlackLine used
match_setslist
The match sets
page_start_indexnumber
Where this page starts, as BlackLine counts it
total_itemsnumber
How many records match in all
Example output
{
  "count": 1,
  "items_per_page": 25,
  "match_sets": [
    {
      "dataSources": [
        {
          "dataSourceId": 10,
          "dataSourceName": "Bank feed - US"
        },
        {
          "dataSourceId": 11,
          "dataSourceName": "GL cash"
        }
      ],
      "description": "Daily bank feed against the cash GL account",
      "isGroup": false,
      "matchSetId": 42,
      "name": "Bank to GL - Operating"
    }
  ],
  "page_start_index": 0,
  "total_items": 1
}

List periods

List BlackLine's accounting periods with their end dates and whether each is current or closed, or only the current one.

Inputs

Only the current periodcurrent_onlytrue/false
Turn on to get only the current period.
Pagepagenumber
Which page to get, counted from 0 as BlackLine counts it. Leave empty for the first page.At least 0.
Page sizepage_sizenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records this page holds
items_per_pagenumber
The page size BlackLine used
page_start_indexnumber
Where this page starts, as BlackLine counts it
periodslist
The periods
total_itemsnumber
How many records match in all
Example output
{
  "count": 1,
  "items_per_page": 25,
  "page_start_index": 0,
  "periods": [
    {
      "endDate": "2026-10-31",
      "id": 245,
      "isBalanceClosed": false,
      "isClosed": false,
      "isCurrent": true,
      "isTaskPeriodClosed": false,
      "name": "October 2026",
      "number": 10,
      "reconciliationFrequency": 1,
      "year": 2026
    }
  ],
  "total_items": 1
}

List report runs

List the reports the connected user has run in BlackLine, with their status, times and export links.

Inputs

None.

Outputs

countnumber
How many report runs
report_runslist
The report runs
Example output
{
  "count": 1,
  "report_runs": [
    {
      "creatorFirstAndLastName": "Jane Doe",
      "endTimeUtc": "2026-11-13T08:01:12Z",
      "exportUrls": [
        {
          "type": "CSV",
          "url": "https://us.api.blackline.com/api/completedqueryrun/3301/CSV"
        }
      ],
      "id": 3301,
      "message": "",
      "name": "Open items by account",
      "notes": "",
      "startTimeUtc": "2026-11-13T08:00:00Z",
      "status": "Completed"
    }
  ]
}

List teams

List BlackLine teams with their codes and where they sit in the team hierarchy, optionally by name. Gets one page.

Inputs

Namenametext
Only the team with this exact name.
Pagepagenumber
Which page to get, counted from 0 as BlackLine counts it. Leave empty for the first page.At least 0.
Page sizepage_sizenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records this page holds
items_per_pagenumber
The page size BlackLine used
page_start_indexnumber
Where this page starts, as BlackLine counts it
teamslist
The teams
total_itemsnumber
How many records match in all
Example output
{
  "count": 1,
  "items_per_page": 25,
  "page_start_index": 0,
  "teams": [
    {
      "id": 77,
      "level": 2,
      "name": "Accounts Payable East",
      "parentId": 12,
      "uniqueCode": "AP-EAST"
    }
  ],
  "total_items": 1
}

List users

List BlackLine users with their login, email, status and default role, optionally by login, email or role. Gets one page.

Inputs

Loginlogin_idtext
Only the user who signs in with this name.
Emailemailtext
Only users with this email address.
Rolerole_idtext
Only users who have this role.
Pagepagenumber
Which page to get, counted from 0 as BlackLine counts it. Leave empty for the first page.At least 0.
Page sizepage_sizenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records this page holds
items_per_pagenumber
The page size BlackLine used
page_start_indexnumber
Where this page starts, as BlackLine counts it
total_itemsnumber
How many records match in all
userslist
The users
Example output
{
  "count": 1,
  "items_per_page": 25,
  "page_start_index": 0,
  "total_items": 1,
  "users": [
    {
      "annualHours": 2000,
      "created": "2026-01-05T14:00:00",
      "defaultRoleId": 1,
      "email": "jane.doe@example.com",
      "firstName": "Jane",
      "fullName": "Jane Doe",
      "id": 1042,
      "isActive": true,
      "jobTitle": "Senior Accountant",
      "lastName": "Doe",
      "lastUpdated": "2026-10-01T09:30:00",
      "loginId": "jane.doe",
      "phoneNumber": "(555) 555-1234",
      "referenceField1": "GL-East",
      "referenceField2": "",
      "referenceField3": "",
      "supervisor": "Sam Lee",
      "timeZoneId": 3
    }
  ]
}

Remove user from team

Take a BlackLine user off one team.

Inputs

UserusertextRequired
The BlackLine user. Pick one, or give their id.
TeamteamtextRequired
The team. Pick one, or give its id.

Outputs

removedtrue/false
True once BlackLine accepted it
team_idnumber
The team's id
user_idnumber
The user's id
Example output
{
  "removed": true,
  "team_id": 77,
  "user_id": 1042
}

Run matching

Run Transaction Matching's engine on one or more match sets, now or at a set time, to match their transactions by their pass rules.

Inputs

Match setsmatch_set_idslistRequired
The match sets to run.
Start atstart_atdate and time
When to run. Leave empty to run as soon as possible.

Outputs

all_scheduledtrue/false
True if every job was scheduled
countnumber
How many jobs BlackLine answered for
jobslist
One job per match set
Example output
{
  "all_scheduled": true,
  "count": 1,
  "jobs": [
    {
      "job_profile_id": 2176137,
      "match_set_id": 42,
      "message": "Job scheduled.",
      "scheduled": true
    }
  ]
}

Update user

Change a BlackLine user's details, such as their email, job title or whether they can sign in. Fields left empty keep their values.

Inputs

UserusertextRequired
The BlackLine user. Pick one, or give their id.
Loginlogin_idtext
The name they sign in to BlackLine with, such as jane.doe. Leave empty to keep it as it is.
First namefirst_nametext
Their first name. Leave empty to keep it as it is.
Last namelast_nametext
Their last name. Leave empty to keep it as it is.
Emailemailtext
Their email address. Leave empty to keep it as it is.
Time zonetime_zone_idtext
Their time zone. Leave empty to keep it as it is.
Activeis_activetrue/false
On to let them sign in, off to stop them. Leave empty to keep it as it is.
Job titlejob_titletext
Their job title. Leave empty to keep it as it is.
Phone numberphone_numbertext
Their phone number. Leave empty to keep it as it is.
Supervisorsupervisortext
Their supervisor's name. Leave empty to keep it as it is.
Annual hoursannual_hoursnumber
The hours they work in a year, such as 2000. Leave empty to keep it as it is.From 0 to 8784.
Reference field 1reference_field_1text
Your own reference value. Leave empty to keep it as it is.
Reference field 2reference_field_2text
Your own reference value. Leave empty to keep it as it is.
Reference field 3reference_field_3text
Your own reference value. Leave empty to keep it as it is.

Outputs

userobject
The user
Example output
{
  "user": {
    "annualHours": 2000,
    "created": "2026-01-05T14:00:00",
    "defaultRoleId": 1,
    "email": "jane.doe@example.com",
    "firstName": "Jane",
    "fullName": "Jane Doe",
    "id": 1042,
    "isActive": true,
    "jobTitle": "Senior Accountant",
    "lastName": "Doe",
    "lastUpdated": "2026-10-01T09:30:00",
    "loginId": "jane.doe",
    "phoneNumber": "(555) 555-1234",
    "referenceField1": "GL-East",
    "referenceField2": "",
    "referenceField3": "",
    "supervisor": "Sam Lee",
    "timeZoneId": 3
  }
}

On this page