NewCraft API (0.0.9)

This describes the endpoints for NewCrafts' integration API. These endpoints are subject to change.

Authentication

application

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: /oauth/token
Scopes:
  • read -

    allows reading resources

Organization

Read organization data for all organizations

Retrieves organization data (including company name, EIN, and payment information) for every company associated with your account.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/orgs/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Read organization data for a specific organization

Retrieves organization data (including company name, EIN, and payment information) for a particular organization.

path Parameters

NameDescription
organization_id
string*

The ID associated with a particular organization. Each organization ID is assigned by NewCraft. You can find relevant organization IDs by retrieving all organizations in your account and taking note of the IDs associated with the relevant organizations.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/orgs/%7Borganization_id%7D/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Payroll

Retrieve a list of payroll runs

Retrieves aggregate payroll run data.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/payrolls/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Retrieve a specific payroll run

Retrieves a specific payroll run data.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/payrolls/:payroll_id/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Read payments for benefits, deductions, salaries, and taxes for all employees

Retrieves aggregate payroll run data.

path Parameters

NameDescription
fiscal_year
integer*

The year associated with the information being accessed, given in the form "YYYY."

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/payroll/get/%7Bfiscal_year%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Read individual payroll data such as job title, start date, and salary

Retrieves individual payroll run data.

path Parameters

NameDescription
payroll_id
string*

The ID associated with a particular payroll. Each payroll ID is assigned by NewCraft. You can find relevant payroll IDs by retrieving all payroll itemss in your account and taking note of the IDs associated with the relevant teams.

fiscal_year
integer*

The year associated with the information being accessed, given in the form "YYYY."

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/payroll/%7Bfiscal_year%7D/%7Bpayroll_id%7Dget \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Payroll Employees

Retrieve payroll information for a specific payroll, including data on gross pay, taxes, and deductions.

Retrieves aggregate employee payroll run data.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/payrolls/:payroll_id/employees_payrolls/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Retrieve a list of employee payroll runs for the payroll run

Retrieves a specific payroll run data.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/payrolls/:payroll_id/employees_payrolls/:employee_payroll_id/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Employees

Read aggregate employee data such as names, work emails, and direct reports

Retrieves all the employee information associated with an organization.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/employees/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Read individual employee data

Retrieves the employee information on a specific employee.

path Parameters

NameDescription
employee_id
string*

The ID associated with a particular employee. Each employee ID is assigned by NewCraft. You can find relevant employee IDs by retrieving all employees in your account and taking note of the IDs associated with the relevant employees.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/employees/%7Bemployee_id%7D/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Employee Payrolls

Retrieve a list of employee payrolls

Retrieves aggregate employee payroll run data.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/employees/:employee_id/employee_payrolls/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Retrieve an employee payroll runs for the payroll run

Retrieves a specific payroll run data.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/employees/:employee_id/employee_payrolls/:employee_payroll_id/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Change Requests

Read change request data.

Retrieves all change requests associated with an organization.

query Parameters

NameDescription
page
number

The page number when paginating through a list of objects

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/change_requests/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Read data for a specific job

Retrieves a specific change request associated with your account.

path Parameters

NameDescription
change_request_id
string*

The ID associated with a particular change request. Each change request ID is assigned by NewCraft. You can find relevant change request IDs by retrieving all change requests in your account and taking note of the IDs associated with the relevant change requests.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/change_requests/%7Bchange_request_id%7D/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Jobs

Read job data such as title, description, status, and location.

Retrieves all jobs associated with an organization.

query Parameters

NameDescription
page
number

The page number when paginating through a list of objects

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/jobs/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Read data for a specific job

Retrieves a specific job associated with your account.

path Parameters

NameDescription
job_id
string*

The ID associated with a particular job. Each job ID is assigned by NewCraft. You can find relevant job IDs by retrieving all jobs in your account and taking note of the IDs associated with the relevant jobs.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/jobs/%7Bjob_id%7D/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Creates a new Job

Creates a new Job.

Request Body schema:

NameDescription
job
object

N/A

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/jobs/create \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"job":{"description_html":"<strong>A great job</strong>","description_text":"A great job","name":"Senior Software Engineer","location":"Brooklyn, New York","remote":true}}'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Creates a new Job

Updates an existing Job.

path Parameters

NameDescription
job_id
string*

The ID associated with a particular job. Each job ID is assigned by NewCraft. You can find relevant job IDs by retrieving all jobs in your account and taking note of the IDs associated with the relevant jobs.

Request Body schema:

NameDescription
job
object

N/A

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/jobs/%7Bjob_id%7D/update \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"job":{"description_html":"<strong>A great job</strong>","description_text":"A great job","name":"Senior Software Engineer","location":"Brooklyn, New York","remote":true}}'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Candidates

Read aggregate candidate data such as names, resumes, and statuses

Retrieves all the candidates who have applied for a job.

path Parameters

NameDescription
job_id
string*

The ID associated with a particular job. Each job ID is assigned by NewCraft. You can find relevant job IDs by retrieving all jobs in your account and taking note of the IDs associated with the relevant jobs.

query Parameters

NameDescription
page
number

The page number when paginating through a list of objects

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/jobs/%7Bjob_id%7D/candidates/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": [
    ]
}
Was this section helpful? Yes No

Create a new candidate for the job

Create a new candidates for a job.

path Parameters

NameDescription
job_id
string*

The ID associated with a particular job. Each job ID is assigned by NewCraft. You can find relevant job IDs by retrieving all jobs in your account and taking note of the IDs associated with the relevant jobs.

Request Body schema:

NameDescription
candidate
object

N/A

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/jobs/%7Bjob_id%7D/candidates/create \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"candidate":{"address":"226 St. James Pl, Brooklyn, NY 11238","first_name":"Kimberly","last_name":"Jones","email":"k.jones@gmail.com","email_type":"work","phone_number_type":"mobile","phone_number":"123-444-5678","status":"applied"}}'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Read candidate data for a specific job

Retrieves a particular candidate who applied for a job.

path Parameters

NameDescription
job_id
string*

The ID associated with a particular job. Each job ID is assigned by NewCraft. You can find relevant job IDs by retrieving all jobs in your account and taking note of the IDs associated with the relevant jobs.

candidate_id
string*

The ID associated with a particular candidate. Each candidate ID is assigned by NewCraft. You can find relevant candidate IDs by retrieving jobs for all candidates in your account and taking note of the IDs associated with the relevant candidates.

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/jobs/%7Bjob_id%7D/candidates/%7Bcandidate_id%7D/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Update a candidate

Create a new candidates for a job.

path Parameters

NameDescription
job_id
string*

The ID associated with a particular job. Each job ID is assigned by NewCraft. You can find relevant job IDs by retrieving all jobs in your account and taking note of the IDs associated with the relevant jobs.

candidate_id
string*

The ID associated with a particular candidate. Each candidate ID is assigned by NewCraft. You can find relevant candidate IDs by retrieving jobs for all candidates in your account and taking note of the IDs associated with the relevant candidates.

Request Body schema:

NameDescription
candidate
object

N/A

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/jobs/%7Bjob_id%7D/candidates/%7Bcandidate_id%7D/update \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"candidate":{"address":"226 St. James Pl, Brooklyn, NY 11238","first_name":"Kimberly","last_name":"Jones","email":"k.jones@gmail.com","email_type":"work","phone_number_type":"mobile","phone_number":"123-444-5678","status":"applied"}}'
Response
{
  • "data": {
    }
}
Was this section helpful? Yes No

Public Tokens

Exchange a public token for an access token

Request Body schema:

The public token received after a connection request.

NameDescription
public_token
string

N/A

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/public_token/exchange \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"public_token":"string"}'
Response
{
  • "type": "string",
  • "attributes": {
    }
}
Was this section helpful? Yes No

Connect Tokens

Create a connect token with limited access for 30 minutes

Responses

StatusDescription
200 successOK
Shell + Curl
Send
curl --request POST \
  --url https://sandbox.newcraft.io/connect_tokens/create \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response
{
  • "type": "string",
  • "attributes": {
    }
}
Was this section helpful? Yes No