Workstream Public API

https://docs.workstream.us/
Admin
Workstream Public API provides a RESTful interface to manage positions, applicants, company users,...
Tokens:47,886
Snippets:168
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /v2/employees - 200 Response Example

Source: https://docs.workstream.us/

Example 200 response for the GET /v2/employees endpoint. Shows the full employee object structure including job assignments, earning rates, direct deposits, and eligibility fields. Note that some fields are nullable or contain placeholder values.

```json
{
  "data": [
    {
      "uuid": "d404e957-af95-4776-af16-bae088e49165",
      "first_name": "Ryan",
      "middle_initial": "J",
      "last_name": "Folk",
      "preferred_name": "Johnny",
      "start_date": "2019-08-24",
      "applied_date": "2019-08-24",
      "hired_date": "2019-08-24",
      "onboard_date": "2019-08-24T14:15:22Z",
      "status": "active",
      "termination_date": "2019-08-24",
      "termination_note": "string",
      "information": {
        "phone": "+17789882873",
        "email": "wadam@example.fr",
        "birthday": "2019-08-24",
        "ethnicity": "black_or_african_american",
        "gender": "male",
        "ssn": "0015594",
        "marital_status": "never_married"
      },
      "address": {
        "address": "6488 Gateway dr",
        "city": "Washington",
        "state": "United States",
        "country": "Virginia",
        "zipcode": "23703"
      },
      "emergency_contact": {
        "name": "Melinda Folk",
        "email": "folk@example.fr",
        "phone": "+16084559135",
        "relationship": "Father"
      },
      "company": {
        "uuid": "5b7f2a90-1c33-4a1c-9f5a-2f9d1c3b8e21",
        "name": "Blue Bottle Coffee"
      },
      "location": {
        "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "name": "Downtown"
      },
      "department": {
        "uuid": "5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c",
        "name": "Front of House"
      },
      "job_assignments": [
        {
          "id": "0d7c67ba-4a15-4c6d-9d5e-3f0f6a1b2c3d",
          "job_id": "7e2f1a4b-8c9d-4e5f-a6b7-c8d9e0f1a2b3",
          "primary": true,
          "status": "active",
          "title": "Barista",
          "location_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
          "department_id": "5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c",
          "managerial": false,
          "soc_code": "35-3023",
          "created_at": "2025-01-01T08:00:00Z",
          "working_location": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "core_location_id": "224c13e3-8d09-4c3d-9795-5f1359449e28"
          },
          "manage_locations": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "core_location_id": "224c13e3-8d09-4c3d-9795-5f1359449e28"
            }
          ],
          "earning_rates": [
            {
              "id": "3c2b1a09-8d7e-4f6a-b5c4-d3e2f1a0b9c8",
              "name": "Hourly",
              "earning_type": "hourly",
              "amount": 18.5,
              "period": "hour",
              "status": "active",
              "external_earning_code_id": "string",
              "effective_date": "2025-01-01"
            }
          ],
          "latest_earning_snapshot": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "version": 0,
            "created_at": "2019-08-24T14:15:22Z",
            "periods": [
              {
                "id": null,
                "start_date": null,
                "end_date": null,
                "earning_rates_data": []
              }
            ]
          }
        }
      ],
      "custom_forms": [
        {
          "name": "Custom form",
          "content": [
            {
              "question": {
                "title": null,
                "content": null
              },
              "answer": [
                null
              ]
            }
          ]
        }
      ],
      "direct_deposits": [
        {
          "payment_method": "direct_deposit",
          "bank_name": "Chase",
          "account_number": "6789",
          "account_type": "checking",
          "routing_number": "021000021",
          "percentage": 100,
          "amount": 0,
          "priority": 0,
          "status": "validated"
        }
      ],
      "eligibility": {
        "admission_number": "string",
        "alien_authorized_to_work_expiration_date": "2019-08-24",
        "alien_registration_or_uscis_number": "string",
        "country_of_issuance": "string"
      }
    }
  ]
}
```

--------------------------------

### Update Team Member Status Response Example

Source: https://docs.workstream.us/

Example response for a successful update (200 OK). Contains the team member's UUID, name fields, termination note, start date, and current status.

```json
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "first_name": "Ryan",
  "middle_initial": "J",
  "last_name": "Folk",
  "preferred_name": "Johnny",
  "termination_note": "string",
  "start_date": "2019-08-24",
  "status": "hired"
}
```

--------------------------------

### Employee Response Example (200 OK)

Source: https://docs.workstream.us/

Example 200 OK response body for the GET /v2/employees/{uuid} endpoint. Shows the employee object with embedded resources such as information, address, emergency contact, company, location, department, and job assignments with earning rates.

```json
{
  "uuid": "d404e957-af95-4776-af16-bae088e49165",
  "first_name": "Ryan",
  "middle_initial": "J",
  "last_name": "Folk",
  "preferred_name": "Johnny",
  "start_date": "2019-08-24",
  "applied_date": "2019-08-24",
  "hired_date": "2019-08-24",
  "onboard_date": "2019-08-24T14:15:22Z",
  "status": "active",
  "termination_date": "2019-08-24",
  "termination_note": "string",
  "information": {
    "phone": "+17789882873",
    "email": "wadam@example.fr",
    "birthday": "2019-08-24",
    "ethnicity": "black_or_african_american",
    "gender": "male",
    "ssn": "0015594",
    "marital_status": "never_married"
  },
  "address": {
    "address": "6488 Gateway dr",
    "city": "Washington",
    "state": "United States",
    "country": "Virginia",
    "zipcode": "23703"
  },
  "emergency_contact": {
    "name": "Melinda Folk",
    "email": "folk@example.fr",
    "phone": "+16084559135",
    "relationship": "Father"
  },
  "company": {
    "uuid": "5b7f2a90-1c33-4a1c-9f5a-2f9d1c3b8e21",
    "name": "Blue Bottle Coffee"
  },
  "location": {
    "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "name": "Downtown"
  },
  "department": {
    "uuid": "5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c",
    "name": "Front of House"
  },
  "job_assignments": [
    {
      "id": "0d7c67ba-4a15-4c6d-9d5e-3f0f6a1b2c3d",
      "job_id": "7e2f1a4b-8c9d-4e5f-a6b7-c8d9e0f1a2b3",
      "primary": true,
      "status": "active",
      "title": "Barista",
      "location_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "department_id": "5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c",
      "managerial": false,
      "soc_code": "35-3023",
      "created_at": "2025-01-01T08:00:00Z",
      "working_location": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "core_location_id": "224c13e3-8d09-4c3d-9795-5f1359449e28"
      },
      "manage_locations": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "core_location_id": "224c13e3-8d09-4c3d-9795-5f1359449e28"
        }
      ],
      "earning_rates": [
        {
          "id": "3c2b1a09-8d7e-4f6a-b5c4-d3e2f1a0b9c8",
          "name": "Hourly",
          "earning_type": "hourly",
          "amount": 18.5,
          "period": "hour",
          "status": "active",
          "external_earning_code_id": "string",
          "effective_date": "2025-01-01"
        }
      ],
      "latest_earning_snapshot": {}
    }
  ]
}
```

--------------------------------

### 200 response for GET /employees

Source: https://docs.workstream.us/

Example 200 response for the GET /employees endpoint. Shows the structure of employee data including personal, employment, compensation, and tax information.

```json
{
  "data": [
    {
      "uuid": "d404e957-af95-4776-af16-bae088e49165",
      "first_name": "Ryan",
      "middle_initial": "J",
      "last_name": "Folk",
      "preferred_name": "Johnny",
      "start_date": "2019-08-24",
      "applied_date": "2019-08-24",
      "hired_date": "2019-08-24",
      "onboard_date": "2019-08-24T14:15:22Z",
      "status": "completed",
      "information": {
        "phone": "+17789882873",
        "email": "wadam@example.fr",
        "birthday": "2019-08-24",
        "ethnicity": "black_or_african_american",
        "gender": "male",
        "ssn": "0015594",
        "marital_status": "never_married"
      },
      "address": {
        "address": "6488 Gateway dr",
        "city": "Washington",
        "state": "United States",
        "country": "Virginia",
        "zipcode": "23703"
      },
      "emergency_contact": {
        "name": "Melinda Folk",
        "email": "folk@example.fr",
        "phone": "+16084559135",
        "relationship": "Father"
      },
      "employment_details": {
        "applied_date": "2019-08-24",
        "department_name": "Staff",
        "hired_date": "2019-08-24",
        "job_title": "Barista",
        "manager": "Test Manager",
        "start_date": "2019-08-24"
      },
      "work_location": {
        "name": "Store",
        "address": "800 Kings Way",
        "city": "Vancouver",
        "state": "VA",
        "country": "US",
        "zipcode": "23321"
      },
      "compensation": {
        "additional_remuneration": "2",
        "additional_remuneration_currency_code": "USD",
        "employment_status": "full_time",
        "status": "non_exempt",
        "wage_amount": "12",
        "wage_currency_code": "USD",
        "wage_pay_frequency": "hour"
      },
      "direct_deposits": [
        {
          "account_number": "112223344",
          "account_type": "saving",
          "percentage": 0,
          "routing_number": "00356",
          "status": "active"
        }
      ],
      "federal_tax": {
        "deductions": 0,
        "extra_withholding": 0,
        "filing_status": "string",
        "other_income": 0,
        "qualifying_children_num": 0,
        "qualifying_other_num": 0,
        "dependents": 0
      }
    }
  ]
}
```

--------------------------------

### List employee documents response example

Source: https://docs.workstream.us/

Example successful response for the list employee documents endpoint. Returns an array of employee documents with URL, type, and creation timestamp.

```json
{
  "data": [
    {
      "employee_uuid": "d404e957-af95-4776-af16-bae088e49165",
      "documents": [
        {
          "url": "https://example.com/employee/docs/123",
          "type": "w4",
          "created_at": "2022-09-30T00:00:00.000Z"
        }
      ]
    }
  ]
}
```

--------------------------------

### Team Member Response Example (200)

Source: https://docs.workstream.us/

Example JSON response for a successful 200 request to GET /team_members/{uuid}. Shows the full team member object including job title, location, department, tax information, and custom fields.

```json
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "first_name": "Ryan",
  "middle_initial": "J",
  "last_name": "Folk",
  "preferred_name": "Johnny",
  "termination_note": "string",
  "start_date": "2019-08-24",
  "status": "hired",
  "job_title": {
    "uuid": "c59c9852-2584-11ee-be56-0242ac120002",
    "title": "Bus Driver"
  },
  "location": {
    "uuid": "c59c9852-2584-11ee-be56-0242ac120002",
    "name": "SF store"
  },
  "department": {
    "uuid": "c59c9852-2584-11ee-be56-0242ac120002",
    "name": "Marketing"
  },
  "information": {
    "phone": "+17789882873",
    "email": "wadam@example.fr",
    "dob": "2020-04-01",
    "ethnicity": "black_or_african_american",
    "gender": "male",
    "ssn": "222521248",
    "marital_status": "never_married"
  },
  "direct_deposits": [
    {
      "account_number": "112223344",
      "account_type": "saving",
      "percentage": 0,
      "routing_number": "00356",
      "status": "active"
    }
  ],
  "state_tax": {
    "allowances_exemptions": 0,
    "extra_withholding": 0,
    "filing_status": "string",
    "tax_form": "string",
    "state": "string",
    "tax_form_details": { }
  },
  "federal_tax": {
    "deductions": 0,
    "extra_withholding": 0,
    "filing_status": "string",
    "other_income": 0,
    "qualifying_children_num": 0,
    "qualifying_other_num": 0,
    "two_jobs": true
  },
  "eligibility": {
    "allowances_exemptions": 0,
    "extra_withholding": 0,
    "filing_status": "string",
    "tax_form": "string"
  },
  "custom_fields": [
    {
      "uuid": "509a251a-93af-41e3-8416-23b29dc293cc",
      "title": "custom field title",
      "value": "custom field value"
    }
  ]
}
```

--------------------------------

### Imported Employee Infos 200 Response

Source: https://docs.workstream.us/

Example 200 response for the GET /imported_employee_infos endpoint. Shows the structure of an imported employee info object.

```json
{
  "imported_employee_infos": [
    {
      "first_name": "Tom",
      "last_name": "string",
      "phone": "+17789882873",
      "email": "string",
      "rehire_eligiblity": "eligible",
      "termination_reason": "string"
    }
  ]
}
```

--------------------------------

### List Positions - 200 Response

Source: https://docs.workstream.us/

Example JSON response for a successful GET /positions request. Contains a data array with position objects, each including uuid, title, status, location, and custom_fields.

```json
{
  "data": [
    {
      "uuid": "c59c9852-2584-11ee-be56-0242ac120002",
      "digest_key": "40ad0bd6836b9e5cfedbf28e7c907fe229a99a2a",
      "title": "Customer Success Associate",
      "overview": "We are looking for a full-time, dedicated, and passionate individual to join our growing team.",
      "status": "published",
      "number": "1845",
      "access": "public",
      "pay_amount": "15$",
      "pay_frequency": "hourly",
      "job_type": "full_time",
      "normalized_titles": "string",
      "remote_type": "on_site",
      "job_url": "https://got.work/ryan_burgers_ryans_radical_rapping_teddy_bears/ad4b4e75",
      "location": {
        "uuid": "fc4487ce-67n0-436e-9aa7-a2eb496aff0e",
        "name": "SF store",
        "address": "string",
        "postal_code": "string",
        "city": "string",
        "state": "string",
        "country": "string"
      },
      "custom_fields": [
        {
          "uuid": "509a251a-93af-41e3-8416-23b29dc293cc",
          "title": "custom field title",
          "value": "custom field value"
        }
      ]
    }
  ]
}
```

--------------------------------

### Retrieve Employee Response Example (200 OK)

Source: https://docs.workstream.us/

Example JSON response for a successful retrieval of an employee, showing all embedded resources such as information, address, emergency contact, employment details, work location, compensation, direct deposits, federal tax, state tax, eligibility, and eligibility details.

```json
{
  "uuid": "d404e957-af95-4776-af16-bae088e49165",
  "first_name": "Ryan",
  "middle_initial": "J",
  "last_name": "Folk",
  "preferred_name": "Johnny",
  "start_date": "2019-08-24",
  "applied_date": "2019-08-24",
  "hired_date": "2019-08-24",
  "onboard_date": "2019-08-24T14:15:22Z",
  "status": "completed",
  "information": {
    "phone": "+17789882873",
    "email": "wadam@example.fr",
    "birthday": "2019-08-24",
    "ethnicity": "black_or_african_american",
    "gender": "male",
    "ssn": "0015594",
    "marital_status": "never_married"
  },
  "address": {
    "address": "6488 Gateway dr",
    "city": "Washington",
    "state": "United States",
    "country": "Virginia",
    "zipcode": "23703"
  },
  "emergency_contact": {
    "name": "Melinda Folk",
    "email": "folk@example.fr",
    "phone": "+16084559135",
    "relationship": "Father"
  },
  "employment_details": {
    "applied_date": "2019-08-24",
    "department_name": "Staff",
    "hired_date": "2019-08-24",
    "job_title": "Barista",
    "manager": "Test Manager",
    "start_date": "2019-08-24"
  },
  "work_location": {
    "name": "Store",
    "address": "800 Kings Way",
    "city": "Vancouver",
    "state": "VA",
    "country": "US",
    "zipcode": "23321"
  },
  "compensation": {
    "additional_remuneration": "2",
    "additional_remuneration_currency_code": "USD",
    "employment_status": "full_time",
    "status": "non_exempt",
    "wage_amount": "12",
    "wage_currency_code": "USD",
    "wage_pay_frequency": "hour"
  },
  "direct_deposits": [
    {
      "account_number": "112223344",
      "account_type": "saving",
      "percentage": 0,
      "routing_number": "00356",
      "status": "active"
    }
  ],
  "federal_tax": {
    "deductions": 0,
    "extra_withholding": 0,
    "filing_status": "string",
    "other_income": 0,
    "qualifying_children_num": 0,
    "qualifying_other_num": 0,
    "dependents": 0,
    "two_jobs": true,
    "exempt_from_withholding": "string"
  },
  "state_tax": {
    "allowances_exemptions": 0,
    "extra_withholding": 0,
    "filing_status": "string",
    "tax_form": "string",
    "state": "string",
    "tax_form_details": {}
  },
  "eligibility": {
    "admission_number": "string",
    "alien_authorized_to_work_expiration_date": "2019-08-24",
    "alien_registration_or_uscis_number": "string",
    "country_of_issuance": "string",
    "lawful_permanent_resident_alien_registration_or_uscis_number": 0,
    "passport_number": "string",
    "resident_status_code": "string",
    "social_security_number": "string"
  },
  "eligibility_details": {
    "i9_section_one": {
      "admission_number": "string",
      "alien_authorized_to_work_expiration_date": "2019-08-24",
      "alien_registration_or_uscis_number": "string",
      "country_of_issuance": "string",
      "lawful_permanent_resident_alien_registration_or_uscis_number": 0,
      "passport_number": "string",
      "resident_status_code": "string",
      "social_security_number": "string",
      "employee_signed_date": "2019-08-24"
    },
    "i9_section_two": {
      "employer_fname": "string",
      "employer_lname": "string",
      "employer_job_title": "string",
      "employee_start_date": "string",
      "employer_signed_date": "2019-08-24",
      "list_a": {
        "list_a_document_title_1": "string",
        "list_a_document_number_1": "string",
        "list_a_expiration_date_1": "2019-08-24"
      }
    }
  }
}
```

--------------------------------

### Retrieve a Position - 200 Response

Source: https://docs.workstream.us/

Example JSON response for a successful GET /positions/{uuid} request. Contains position fields including uuid, title, status, location, and custom_fields.

```json
{
  "uuid": "c59c9852-2584-11ee-be56-0242ac120002",
  "digest_key": "40ad0bd6836b9e5cfedbf28e7c907fe229a99a2a",
  "title": "Customer Success Associate",
  "overview": "We are looking for a full-time, dedicated, and passionate individual to join our growing team.",
  "status": "published",
  "number": "1845",
  "access": "public",
  "pay_amount": "15$",
  "pay_frequency": "hourly",
  "job_type": "full_time",
  "normalized_titles": "string",
  "remote_type": "on_site",
  "job_url": "https://got.work/ryan_burgers_ryans_radical_rapping_teddy_bears/ad4b4e75",
  "location": {
    "uuid": "fc4487ce-67n0-436e-9aa7-a2eb496aff0e",
    "name": "SF store",
    "address": "string",
    "postal_code": "string",
    "city": "string",
    "state": "string",
    "country": "string"
  },
  "custom_fields": [
    {
      "uuid": "509a251a-93af-41e3-8416-23b29dc293cc",
      "title": "custom field title",
      "value": "custom field value"
    }
  ]
}
```

--------------------------------

### 200 OK Response for List Applicant's Custom Forms

Source: https://docs.workstream.us/

Example 200 OK response for the GET /position_applications/{uuid}/forms endpoint. Shows the structure of the returned data, including the form UUID, name, and an array of answers with question details and the applicant's answer.

```json
{
  "data": [
    {
      "uuid": "d404e957-af95-4776-af16-bae088e49165",
      "name": "Additional Information",
      "answers": [
        {
          "question_uuid": "d404e957-af95-4776-af16-bae088e49165",
          "question_type": "multiple_choice",
          "question": "Are you at least 18 years old with a valid Driver's license?",
          "answer_uuid": "d404e957-af95-4776-af16-bae088e49165",
          "answer": "yes"
        }
      ]
    }
  ]
}
```

--------------------------------

### Custom Fields 200 Response

Source: https://docs.workstream.us/

Example 200 response for the GET /custom_fields endpoint. Shows the structure of a custom field object, including id, entity_type, title, description, is_required, field_type, options, and sequence.

```json
{
  "custom_fields": [
    {
      "id": "1300622b-1bfa-41b2-b182-ca9425d140ca",
      "entity_type": "location",
      "title": "Location Reference No.",
      "description": "This is reference number on ADP side",
      "is_required": true,
      "field_type": "select",
      "options": "string",
      "sequence": 0
    }
  ]
}
```

--------------------------------

### GET /applicants

Source: https://docs.workstream.us/

Lists existing Applicants. This endpoint returns a collection of applicants.

```APIDOC
## GET /applicants

### Description
Lists existing Applicants.

### Method
GET

### Endpoint
/applicants

```

--------------------------------

### GET /departments

Source: https://docs.workstream.us/

Lists existing Departments. This endpoint returns a collection of departments.

```APIDOC
## GET /departments

### Description
Lists existing Departments.

### Method
GET

### Endpoint
/departments

```

--------------------------------

### GET /positions

Source: https://docs.workstream.us/

Lists existing Positions with the input parameters. Requires bearer authentication.

```APIDOC
## GET /positions

### Description
Lists existing Positions with the input parameters.

### Method
GET

### Endpoint
/positions

### Parameters
#### Query Parameters
- **title** (string) - Optional - Returns positions with the input `title`. Example: title=Cook
- **status** (string) - Optional - Returns positions with the input `status`. Enum: "pending" "published" "closed" "deleted" Example: status=published
- **access** (string) - Optional - Returns positions with input `access`. Enum: "link_only" "public" Example: access=link_only
- **location[name]** (string) - Optional - Returns positions with the input location's name. Example: location[name]=SF%20Store
- **created_at.gte** (string <timestamp>) - Optional - Returns positions created after or equals to the input date. Example: created_at.gte=2022-09-30 00:00:00.000Z
- **created_at.lte** (string) - Optional - Returns positions created before or equals to the input date. Example: created_at.lte=2022-09-30 00:00:00.000Z
- **embed** (string) - Optional - Specifies the names of resources that should be embedded in the response. Resources to embed must have parentheses and be comma-separated. Example: embed=(location, custom_fields)

### Request Example
```
curl -i -X GET \
  https://public-api.workstream.us/positions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
```

### Response
#### Success Response (200)
- **data** (array) - An array of position objects.
  - **uuid** (string) - The unique identifier of the position.
  - **digest_key** (string) - A digest key for the position.
  - **title** (string) - The job title.
  - **overview** (string) - A description of the position.
  - **status** (string) - The status of the position (e.g., published).
  - **number** (string) - The position number.
  - **access** (string) - The access level (e.g., public).
  - **pay_amount** (string) - The pay amount.
  - **pay_frequency** (string) - The pay frequency (e.g., hourly).
  - **job_type** (string) - The job type (e.g., full_time).
  - **normalized_titles** (string) - Normalized titles.
  - **remote_type** (string) - The remote type (e.g., on_site).
  - **job_url** (string) - The URL for the job posting.
  - **location** (object) - The location details.
    - **uuid** (string) - Location UUID.
    - **name** (string) - Location name.
    - **address** (string) - Street address.
    - **postal_code** (string) - Postal code.
    - **city** (string) - City.
    - **state** (string) - State.
    - **country** (string) - Country.
  - **custom_fields** (array) - Custom fields associated with the position.
    - **uuid** (string) - Custom field UUID.
    - **title** (string) - Custom field title.
    - **value** (string) - Custom field value.

#### Response Example
```json
{
  "data": [
    {
      "uuid": "c59c9852-2584-11ee-be56-0242ac120002",
      "digest_key": "40ad0bd6836b9e5cfedbf28e7c907fe229a99a2a",
      "title": "Customer Success Associate",
      "overview": "We are looking for a full-time, dedicated, and passionate individual to join our growing team.",
      "status": "published",
      "number": "1845",
      "access": "public",
      "pay_amount": "15$",
      "pay_frequency": "hourly",
      "job_type": "full_time",
      "normalized_titles": "string",
      "remote_type": "on_site",
      "job_url": "https://got.work/ryan_burgers_ryans_radical_rapping_teddy_bears/ad4b4e75",
      "location": {
        "uuid": "fc4487ce-67n0-436e-9aa7-a2eb496aff0e",
        "name": "SF store",
        "address": "string",
        "postal_code": "string",
        "city": "string",
        "state": "string",
        "country": "string"
      },
      "custom_fields": [
        {
          "uuid": "509a251a-93af-41e3-8416-23b29dc293cc",
          "title": "custom field title",
          "value": "custom field value"
        }
      ]
    }
  ]
}
```

### Error Responses
- **401** - Unauthorized - Credentials are not valid for the target resource.
- **403** - Forbidden - The user is not authorized to use this resource.
- **404** - Not found - The requested resource is not found.
- **422** - Unprocessable Entity - Invalid query params or request body.
- **429** - Too many requests.
```

--------------------------------

### GET /employee-documents/{id}/download

Source: https://docs.workstream.us/

Downloads an employee document. This endpoint downloads a specific employee document.

```APIDOC
## GET /employee-documents/{id}/download

### Description
Downloads a employee document.

### Method
GET

### Endpoint
/employee-documents/{id}/download

```

--------------------------------

### GET /positions

Source: https://docs.workstream.us/

Lists existing Positions. This endpoint returns a collection of positions.

```APIDOC
## GET /positions

### Description
Lists existing Positions.

### Method
GET

### Endpoint
/positions

```

--------------------------------

### GET /company-users

Source: https://docs.workstream.us/

Lists existing Company Users. This endpoint returns a collection of company users.

```APIDOC
## GET /company-users

### Description
Lists existing Company Users.

### Method
GET

### Endpoint
/company-users

```

--------------------------------

### Create a new access token - 200 response

Source: https://docs.workstream.us/

Example JSON response for a successful token creation. Contains the token name, token value, creation timestamp, expiration time in seconds (604800), and the list of scopes.

```json
{
  "name": "token1",
  "token": "OtrQV4Gz7nwLouCm-ZLqiSxdwJEMEAFGx___GcNxES8",
  "created_at": "2019-08-24T14:15:22Z",
  "expires_in": 604800,
  "scopes": [
    "positions",
    "company_users",
    "company_roles",
    "position_applications",
    "employees",
    "locations",
    "departments",
    "team_members",
    "imported_employee_infos"
  ]
}
```

--------------------------------

### POST /tokens

Source: https://docs.workstream.us/

Creates a new access token. Requires query parameters for grant type, client credentials, token name, and permission scopes.

```APIDOC
## POST /tokens

### Description
Creates a new access token.

### Method
POST

### Endpoint
https://public-api.workstream.us/tokens

### Parameters
#### Query Parameters
- **grant_type** (string) - Required - Grant type of access token, please use `client_credentials`. Example: grant_type=client_credentials
- **client_id** (string) - Required - Client credentials provided as part of your application. This can be retrieved from the Dashboard under `Company->Integrations->Access Tokens`.
- **client_secret** (string) - Required - The password used to authenticate your application. This can be retrieved from the Dashboard under `Company->Integrations->Access Tokens`.
- **name** (string) - Required - Name of the access token displayed in the Dashboard.
- **scopes** (Array of strings) - Required - Permission scopes of access token. Items Enum: "positions" "company_users" "company_roles" "position_applications" "employees" "locations" "departments" "team_members" "imported_employee_infos"

### Request Example
```
curl -i -X POST \
  https://public-api.workstream.us/tokens
```

### Response
#### Success Response (200)
- **name** (string) - Name of the access token.
- **token** (string) - The access token value.
- **created_at** (string) - Creation timestamp in ISO 8601 format.
- **expires_in** (integer) - Token expiration time in seconds (e.g., 604800).
- **scopes** (Array of strings) - Permission scopes associated with the token.

#### Response Example
```json
{
  "name": "token1",
  "token": "OtrQV4Gz7nwLouCm-ZLqiSxdwJEMEAFGx___GcNxES8",
  "created_at": "2019-08-24T14:15:22Z",
  "expires_in": 604800,
  "scopes": [
    "positions",
    "company_users",
    "company_roles",
    "position_applications",
    "employees",
    "locations",
    "departments",
    "team_members",
    "imported_employee_infos"
  ]
}
```

#### Error Responses
- **401** - Unauthorized

```

--------------------------------

### Company Users 200 OK Response

Source: https://docs.workstream.us/

Example JSON response structure returned when successfully listing company users.

```json
{
  "data": [
    {
      "uuid": "509a251a-93af-41e3-8416-23b29dc293cc",
      "name": "Joey White",
      "status": "active",
      "region_number": "+1",
      "phone": "4155693009",
      "created_at": "2022-09-30T00:00:00.000Z",
      "user": {
        "email": "test@test.com",
        "uuid": "509a251a-93af-41e3-8416-23b29dc293cc",
        "created_at": "2022-09-30T00:00:00.000Z"
      },
      "company_role": {
        "uuid": "509a251a-93af-41e3-8416-23b29dc293cc",
        "name": "General Manager",
        "editable": true,
        "permissions_set": [
          "edit_user edit_location",
          "edit_department",
          "customize_notifications",
          "edit_position",
          "edit_custom_reports",
          "edit_custom_field",
          "edit_integration",
          "edit_company"
        ],
        "created_at": "2022-09-30T00:00:00.000Z"
      },
      "permission_config": {
        "all_locations": false,
        "locations": [
          {
            "uuid": "67161b3c-2584-11ee-be56-0242ac120002",
            "all_departments": false,
            "departments": [
              {
                "uuid": null
              }
            ]
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### List Applicants via cURL

Source: https://docs.workstream.us/

Example request to retrieve position applications using the cURL command-line tool with a bearer token.

```bash
curl -i -X GET \
  https://public-api.workstream.us/position_applications \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
```
Tokens:
Raw