This describes the endpoints for NewCrafts' integration API. These endpoints are subject to change.
Retrieves organization data (including company name, EIN, and payment information) for every company associated with your account.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/orgs/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "39d42a4a-0e36-4a6c-8804-fce588acf032",
- "type": "Organization",
- "attributes": {
- "company_name": "Brooklyn Mint",
- "ein": "55-5555555",
- "company_location": "Bedford-Stuyvesant, Brooklyn, NY, USA",
- "headcount": 23,
- "back_account": {
- "routingNumber": "122101706",
- "accountName": "Stripe",
- "institutionName": "BANK OF AMERICA, N.A.",
- "accountType": "CHECKING",
- "accountNumber": "19879919"
}
}
}, - {
- "id": "39d42a4a-0e36-4a6c-8804-eeeejjeej5445",
- "type": "Organization",
- "attributes": {
- "company_name": "San Francisco",
- "ein": "55-3888474",
- "company_location": "184 Linda St San Francisco, California",
- "headcount": 56,
- "back_account": {
- "routingNumber": "122101706",
- "accountName": "Stripe",
- "institutionName": "BANK OF AMERICA, N.A.",
- "accountType": "CHECKING",
- "accountNumber": "19879919"
}
}
}
]
}
Retrieves organization data (including company name, EIN, and payment information) for a particular organization.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/orgs/%7Borganization_id%7D/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": {
- "id": "39d42a4a-0e36-4a6c-8804-fce588acf032",
- "type": "Organization",
- "attributes": {
- "id": "39d42a4a-0e36-4a6c-8804-fce588acf032",
- "company_name": "Brooklyn Mint",
- "ein": "55-5555555",
- "company_location": "Bedford-Stuyvesant, Brooklyn, NY, USA",
- "headcount": 23,
- "back_account": {
- "routingNumber": "122101706",
- "accountName": "Stripe",
- "institutionName": "BANK OF AMERICA, N.A.",
- "accountType": "CHECKING",
- "accountNumber": "19879919"
}, - "teams": {
- "team_id": "8wigs573-s375-1x14-x9s1-31s8462fd8c3",
- "type": "Product",
- "attributes": {
- "team_id": "8wigs573-s375-1x14-x9s1-31s8462fd8c3",
- "team_name": "Product",
- "team_location": "Los Angeles, CA, USA",
- "team_headcount": 3,
- "pay_schedule": "bimonthly"
}
}
}
}
}
Retrieves aggregate payroll run data.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/payrolls/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "Payroll",
- "attributes": {
- "check_data": "2020-10-29T02:44:05.000Z",
- "pay_period_end_date": "2020-10-29T00:00:00.000Z",
- "pay_period_start_date": "2020-10-15T00:00:00.000Z"
}
}, - {
- "id": "6cfeddd6-f278-4d31-b9b3-01b5505fd5b3",
- "type": "Payroll",
- "attributes": {
- "check_data": "2020-10-29T02:44:05.000Z",
- "pay_period_end_date": "2020-10-29T00:00:00.000Z",
- "pay_period_start_date": "2020-10-15T00:00:00.000Z"
}
}
]
}
Retrieves a specific payroll run data.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/payrolls/:payroll_id/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "Payroll",
- "attributes": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "check_data": "2020-10-29T02:44:05.000Z",
- "pay_period_end_date": "2020-10-29T00:00:00.000Z",
- "pay_period_start_date": "2020-10-15T00:00:00.000Z"
}
}
}
Retrieves aggregate payroll run data.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/payroll/get/%7Bfiscal_year%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "Payroll",
- "attributes": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "check_data": "2020-10-29T02:44:05.000Z",
- "pay_period_end_date": "2020-10-29T00:00:00.000Z",
- "pay_period_start_date": "2020-10-15T00:00:00.000Z"
}
}
}
Retrieves individual payroll run data.
Name | Description |
---|---|
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. |
integer* | The year associated with the information being accessed, given in the form "YYYY." |
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/payroll/%7Bfiscal_year%7D/%7Bpayroll_id%7Dget \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "Payroll",
- "attributes": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "check_data": "2020-10-29T02:44:05.000Z",
- "pay_period_end_date": "2020-10-29T00:00:00.000Z",
- "pay_period_start_date": "2020-10-15T00:00:00.000Z"
}
}
]
}
Retrieves aggregate employee payroll run data.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/payrolls/:payroll_id/employees_payrolls/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "EmployeePayroll",
- "attributes": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "gross_pay": "4055.00",
- "net_pay": "3000.00",
- "taxes": "600.00",
- "payroll_id": "551b88cc-f808-4828-a464-142af620bdce",
- "payroll_check_date": "2020-10-15T00:00:00.000Z",
- "payroll_pay_period_end_date": "2020-10-14T00:00:00.000Z",
- "payroll_pay_period_start_date": "2020-10-01T00:00:00.000Z",
- "deductions": [
- "Flexible Spending Account"
], - "last_refreshed_at": "2020-10-29T02:44:05.000Z"
}
}
]
}
Retrieves a specific payroll run data.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/payrolls/:payroll_id/employees_payrolls/:employee_payroll_id/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "EmployeePayroll",
- "attributes": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "gross_pay": "4055.00",
- "net_pay": "3000.00",
- "taxes": "600.00",
- "payroll_id": "551b88cc-f808-4828-a464-142af620bdce",
- "payroll_check_date": "2020-10-15T00:00:00.000Z",
- "payroll_pay_period_end_date": "2020-10-14T00:00:00.000Z",
- "payroll_pay_period_start_date": "2020-10-01T00:00:00.000Z",
- "deductions": [
- "Flexible Spending Account"
], - "last_refreshed_at": "2020-10-29T02:44:05.000Z"
}
}
}
Retrieves all the employee information associated with an organization.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/employees/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b1",
- "type": "Employee",
- "attributes": {
- "first_name": "Joy",
- "last_name": "Balle",
- "ssn": "555-55-1111",
- "title": "Senior Designer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "Joy.Balle@gmail.com",
- "work_email": "Joy.Balle@Instacart.com",
- "salary": "$125,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "3443 Sixth Street, Unit 1",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d91"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b2",
- "type": "Employee",
- "attributes": {
- "first_name": "Joseph",
- "last_name": "Wallace",
- "ssn": "555-55-5555",
- "title": "Senior Software Engineer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "Joseph.Wallace@gmail.com",
- "work_email": "Joseph.Wallace@Instacart.com",
- "salary": "$125,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "2674 Sixth Street, Unit 381",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d90"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "Employee",
- "attributes": {
- "first_name": "Joseph",
- "last_name": "Wallace",
- "ssn": "555-55-5555",
- "title": "Senior Software Engineer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "Joseph.Wallace@gmail.com",
- "work_email": "Joseph.Wallace@Instacart.com",
- "salary": "$125,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "2674 Sixth Street, Unit 381",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d90"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b4",
- "type": "Employee",
- "attributes": {
- "first_name": "David",
- "last_name": "Joyce",
- "ssn": "555-55-4444",
- "title": "Software Developer",
- "team_id": "949c4a5a-1b81-44f5-9027-dddeee3333",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "David.Joyce@gmail.com",
- "work_email": "David.Joyce@Instacart.com",
- "salary": "$100,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "9485 Seventh Street, Unit 81",
- "manager_id": "39848ed-1b81-18f5-1743-276095ee1d90"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b5",
- "type": "Employee",
- "attributes": {
- "first_name": "Fals",
- "last_name": "Joey",
- "ssn": "555-55-5555",
- "title": "Lead Software Engineer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "Fals.Joey@gmail.com",
- "work_email": "Fals.Joey@Instacart.com",
- "salary": "$195,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "234 Sixth Street, Unit 45",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d90"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b6",
- "type": "Employee",
- "attributes": {
- "first_name": "John",
- "last_name": "Doe",
- "ssn": "555-55-5555",
- "title": "Software Designer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "John.Doe@gmail.com",
- "work_email": "John.Doe@Instacart.com",
- "salary": "$125,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "234 Sixth Street, Unit 45",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d90"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b7",
- "type": "Employee",
- "attributes": {
- "first_name": "John",
- "last_name": "Doe",
- "ssn": "555-55-5555",
- "title": "Software Designer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "John.Doe@gmail.com",
- "work_email": "John.Doe@Instacart.com",
- "salary": "$125,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "234 Sixth Street, Unit 45",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d90"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b8",
- "type": "Employee",
- "attributes": {
- "first_name": "Kel",
- "last_name": "San",
- "ssn": "555-55-5555",
- "title": "Software Designer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "Kel.San@gmail.com",
- "work_email": "Kel.San@Instacart.com",
- "salary": "$125,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "234 Sixth Street, Unit 45",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d90"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b9",
- "type": "Employee",
- "attributes": {
- "first_name": "Paul",
- "last_name": "Joe",
- "ssn": "555-55-5555",
- "title": "Software Designer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "Paul.Joe@gmail.com",
- "work_email": "Paul.Joe@Instacart.com",
- "salary": "$125,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "234 Sixth Street, Unit 45",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d90"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b10",
- "type": "Employee",
- "attributes": {
- "first_name": "Welse",
- "last_name": "Owl",
- "ssn": "555-55-5555",
- "title": "Software Designer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "Welse.Owl@gmail.com",
- "work_email": "Welse.Owl@Instacart.com",
- "salary": "$125,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "234 Sixth Street, Unit 45",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d90"
}
}
]
}
Retrieves the employee information on a specific employee.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/employees/%7Bemployee_id%7D/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "2d472b59-c545-4580-992c-bdfa200fa5aa",
- "type": "Employee",
- "attributes": {
- "first_name": "Joseph",
- "last_name": "Wallace",
- "ssn": "555-55-5555",
- "title": "Senior Software Engineer",
- "team_id": "949c4a5a-1b81-44f5-9027-276095ee5d97",
- "date_of_birth": "1992-03-28T00:00:00.000Z",
- "start_date": "2015-10-12T00:00:00.000Z",
- "end_date": "2019-01-05T00:00:00.000Z",
- "manager": false,
- "phone": "(555) 555-5555",
- "personal_email": "Joseph.Wallace@gmail.com",
- "work_email": "Joseph.Wallace@Instacart.com",
- "salary": "$125,000",
- "gender": "male",
- "location": "Los Angeles, CA, USA",
- "address": "2674 Sixth Street, Unit 381",
- "manager_id": "739b4a5a-1b81-18f5-1743-276095ee1d90"
}
}
]
}
Retrieves aggregate employee payroll run data.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/employees/:employee_id/employee_payrolls/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "EmployeePayroll",
- "attributes": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "gross_pay": "4055.00",
- "net_pay": "3000.00",
- "taxes": "600.00",
- "payroll_id": "551b88cc-f808-4828-a464-142af620bdce",
- "payroll_check_date": "2020-10-15T00:00:00.000Z",
- "payroll_pay_period_end_date": "2020-10-14T00:00:00.000Z",
- "payroll_pay_period_start_date": "2020-10-01T00:00:00.000Z",
- "deductions": [
- "Flexible Spending Account"
], - "last_refreshed_at": "2020-10-29T02:44:05.000Z"
}
}
]
}
Retrieves a specific payroll run data.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/employees/:employee_id/employee_payrolls/:employee_payroll_id/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "EmployeePayroll",
- "attributes": {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "gross_pay": "4055.00",
- "net_pay": "3000.00",
- "taxes": "600.00",
- "payroll_id": "551b88cc-f808-4828-a464-142af620bdce",
- "payroll_check_date": "2020-10-15T00:00:00.000Z",
- "payroll_pay_period_end_date": "2020-10-14T00:00:00.000Z",
- "payroll_pay_period_start_date": "2020-10-01T00:00:00.000Z",
- "deductions": [
- "Flexible Spending Account"
], - "last_refreshed_at": "2020-10-29T02:44:05.000Z"
}
}
}
Retrieves all change requests associated with an organization.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/change_requests/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "type": "change_request",
- "attributes": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "kind": "create",
- "model_class": "Candidate",
- "state": "awaiting_processing",
- "values": { }
}
}
]
}
Retrieves a specific change request associated with your account.
Name | Description |
---|---|
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. |
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/change_requests/%7Bchange_request_id%7D/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "type": "change_request",
- "attributes": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "kind": "create",
- "model_class": "Candidate",
- "state": "awaiting_processing",
- "values": { }
}
}
}
Retrieves all jobs associated with an organization.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/jobs/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "Job",
- "attributes": {
- "location": "Los Angeles, CA, USA",
- "description_html": "<ul><li><b>5</b> years of design experience</li></ul>",
- "description_text": "5 years of design experience",
- "name": "Senior Designer",
- "department_id": "8wigs573-s375-1x14-x9s1-31s8462fd8c3",
- "remote": false,
- "status": "opened"
}
}, - {
- "id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
- "type": "Job",
- "attributes": {
- "location": "Los Angeles, CA, USA",
- "description_html": "<ul><li><b>15</b> years of design experience</li></ul>",
- "description_text": "15 years of design experience",
- "name": "Senior Designer",
- "department_id": "8wigs573-s375-1x14-x9s1-31s8462fd8c3",
- "remote": false,
- "status": "closed"
}
}
]
}
Retrieves a specific job associated with your account.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/jobs/%7Bjob_id%7D/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "type": "job",
- "attributes": {
- "location": "Los Angeles, CA, USA",
- "description_html": "<ul><li><b>5</b> years of design experience</li></ul>",
- "description_text": "5 years of design experience",
- "name": "Senior Designer",
- "department_id": "8wigs573-s375-1x14-x9s1-31s8462fd8c3",
- "remote": false,
- "status": "opened"
}
}
}
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}}'
{- "data": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "type": "change_request",
- "attributes": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "kind": "create",
- "model_class": "Job",
- "state": "awaiting_processing",
- "values": {
- "location": "Los Angeles, CA, USA",
- "description_html": "<ul><li><b>5</b> years of design experience</li></ul>",
- "description_text": "5 years of design experience",
- "name": "Senior Designer",
- "remote": false
}
}
}
}
Updates an existing Job.
Status | Description |
---|---|
200 success | OK |
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}}'
{- "data": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "type": "change_request",
- "attributes": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "kind": "create",
- "model_class": "Job",
- "state": "awaiting_processing",
- "values": {
- "location": "Los Angeles, CA, USA",
- "description_html": "<ul><li><b>5</b> years of design experience</li></ul>",
- "description_text": "5 years of design experience",
- "name": "Senior Designer",
- "remote": false
}
}
}
}
Retrieves all the candidates who have applied for a job.
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/jobs/%7Bjob_id%7D/candidates/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": [
- {
- "id": "cf778177-84f5-4401-a388-c5b1ee0221e8",
- "type": "Candidate",
- "attributes": {
- "id": "cf778177-84f5-4401-a388-c5b1ee0221e8",
- "address": "226 St. James Pl, Brooklyn, NY 11238",
- "first_name": "Kimberly",
- "last_name": "Jones",
- "email": "k.jones@gmail.com",
- "email_type": "work",
- "job_id": "012c7540-e319-46c7-b387-e06b352cc54f",
- "phone_number_type": "mobile",
- "phone_number": "123-444-5678",
- "status": "applied"
}
}, - {
- "id": "cf778177-84f5-4401-a388-c5b1ee0221e8",
- "type": "Candidate",
- "attributes": {
- "id": "cf778177-84f5-4401-a388-c5b1ee0221e8",
- "address": "226 St. James Pl, Brooklyn, NY 11238",
- "first_name": "Kimberly",
- "last_name": "Jones",
- "email": "k.jones@gmail.com",
- "email_type": "work",
- "job_id": "012c7540-e319-46c7-b387-e06b352cc54f",
- "phone_number_type": "mobile",
- "phone_number": "123-444-5678",
- "status": "applied"
}
}
]
}
Create a new candidates for a job.
Status | Description |
---|---|
200 success | OK |
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"}}'
{- "data": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "type": "change_request",
- "attributes": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "kind": "create",
- "model_class": "Candidate",
- "state": "awaiting_processing",
- "values": {
- "id": "string",
- "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": "interviewed"
}
}
}
}
Retrieves a particular candidate who applied for a job.
Name | Description |
---|---|
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. |
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. |
Status | Description |
---|---|
200 success | OK |
curl --request POST \ --url https://sandbox.newcraft.io/jobs/%7Bjob_id%7D/candidates/%7Bcandidate_id%7D/get \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "data": {
- "id": "cf778177-84f5-4401-a388-c5b1ee0221e8",
- "type": "Candidate",
- "attributes": {
- "id": "string",
- "address": "226 St. James Pl, Brooklyn, NY 11238",
- "first_name": "Kimberly",
- "last_name": "Jones",
- "email": "k.jones@gmail.com",
- "email_type": "work",
- "job_id": "012c7540-e319-46c7-b387-e06b352cc54f",
- "phone_number_type": "mobile",
- "phone_number": "123-444-5678",
- "status": "applied"
}
}
}
Create a new candidates for a job.
Name | Description |
---|---|
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. |
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. |
Status | Description |
---|---|
200 success | OK |
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"}}'
{- "data": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "type": "change_request",
- "attributes": {
- "id": "85626fc0-e140-44d9-aa04-e51f8ed7a56e",
- "kind": "create",
- "model_class": "Candidate",
- "state": "awaiting_processing",
- "values": {
- "id": "string",
- "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": "interviewed"
}
}
}
}
The public token received after a connection request.
Status | Description |
---|---|
200 success | OK |
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"}'
{- "type": "string",
- "attributes": {
- "expires_at": "2020-10-29T02:44:05.000Z",
- "token": "access-sandbox-9dab287a-43ab-4bda-8fd5-b7e713e9b954"
}
}
curl --request POST \ --url https://sandbox.newcraft.io/connect_tokens/create \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{- "type": "string",
- "attributes": {
- "expires_at": "2020-10-29T02:44:05.000Z",
- "token": "connect-sandbox-9dab287a-43ab-4bda-8fd5-b7e713e9b954"
}
}