### Partner-Initiated Installation with Additional Redirect URL

Source: https://developer.rippling.com/documentation/developer-portal/v2-guides/redirect

This example shows how to initiate an app installation using an additional redirect URL. The `redirect_uri` parameter must be explicitly passed to use a non-default URL.

```url
https://app.rippling.com/apps/PLATFORM/INSERTAPPNAME/authorize?response_type=code&client_id=INSERTCLIENTID&redirect_uri=example2.com  

```

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

### Example API Call: GET List schedules

Source: https://developer.rippling.com/documentation/rest-api/guides/time-getting-started

Demonstrates how to make a GET request to the 'schedules' endpoint using curl. Ensure you have the necessary 'Authorization' token with appropriate scopes.

```bash
curl -L -X GET 'https://rest.ripplingapis.com/schedules' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer REDACTED'
```

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

### Example API call: GET List compensation bands details

Source: https://developer.rippling.com/documentation/rest-api/guides/talent-getting-started

Example cURL request and response for fetching compensation band details.

```APIDOC
## Example API call: GET List compensation bands details

### Request
```
curl -L -X GET 'https://rest.ripplingapis.com/compensation-bands-details' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer REDACTED'
```

### Response
```json
{
  "results": [
    {
      "id": "667c578f847b97e5407e93b0",
      "created_at": "2024-06-26T18:01:51.787000+00:00",
      "updated_at": "2024-06-26T18:01:51.788000+00:00",
      "internal_job_code": null,
      "worker_id": "66759ebda4acbe76b80b255f",
      "worker": null
    }
  ],
  "next_link": null
}
```
```

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

### List Functions

Source: https://developer.rippling.com/documentation/rest-api/guides/dev-getting-started

This example demonstrates how to use curl to make a GET request to the /functions endpoint to retrieve a list of functions. It includes the necessary headers for authentication and content acceptance.

```APIDOC
## GET /functions

### Description
Retrieves a list of all available functions configured within the Rippling system.

### Method
GET

### Endpoint
https://rest.ripplingapis.com/functions/

### Parameters
#### Headers
- **Accept** (string) - Required - Specifies the desired response format, typically `application/json`.
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
```bash
curl -L -X GET 'https://rest.ripplingapis.com/functions/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer REDACTED'
```

### Response
#### Success Response (200)
- **results** (array) - A list of function objects.
  - **id** (string) - Unique identifier for the function.
  - **created_at** (string) - Timestamp when the function was created.
  - **updated_at** (string) - Timestamp when the function was last updated.
  - **name** (string) - The display name of the function.
  - **api_name** (string) - The programmatic name of the function.
  - **description** (string) - A description of the function.
  - **code_draft** (string) - The code associated with the function.
  - **dependencies** (object) - An object detailing the function's dependencies.
- **next_link** (string or null) - A link to the next page of results, if available.

#### Response Example
```json
{
  "results": [
    {
      "id": "67af9fdd968c13ed38b352f2",
      "created_at": "2025-02-14T19:56:13.972000+00:00",
      "updated_at": "2025-12-18T23:25:07.197000+00:00",
      "name": "Test",
      "api_name": "test",
      "description": "",
      "code_draft": "{\n    \"object_api_name\": \"pet__c\",\n    \"record_ids\": [\"<object_id>\", \"<object_id>\"],\n    \"current_user\": \"<object_id>\",\n    \"app_id\": \"<object_id>\",\n    \"list_view_id\": \"<object_id>\",\n    \"page_id\": \"<object_id>\",\n    \"button\": \"my_cool_button\",\n    \"url\": \"https://app.rippling.com/custom-apps/objects/rto_expectation__c?app=rto_hub\", 
    \"trigger_type\": \"list view\",\n}",
      "dependencies": {}
    },
    {
      "id": "6966ad672626b42f91393418",
      "created_at": "2026-01-13T20:39:03.525000+00:00",
      "updated_at": "2026-01-13T21:40:17.684000+00:00",
      "name": "Test1",
      "api_name": "test1",
      "description": "",
      "code_draft": "import RipplingSDK, {\n  FunctionContext,\n  FunctionEvent,\n  FunctionResponse,\n} from \"@rippling/rippling-sdk\";\nimport _ from \"lodash\";\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext\n) {\n  const ripplingSDK = new RipplingSDK({ bearerToken: \"REDACTED\" });\n\n  // Log once to discover the real shape\n  console.log(\"event:\", JSON.stringify(event));\n 
  const ownerRole = (event as any).owner_role; // verify from logs\n  const name =\n    (event as any).name ??\n    (event as any).record_id ??\n    (event as any).inputs?.name;\n}",
      "dependencies": {
        "@rippling/rippling-sdk": "^0.2.0-alpha.25",
        "lodash": "^4.17.21",
        "moment": "^2.30.1"
      }
    }
  ],
  "next_link": null
}
```
```

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

### List Employment Types - C# Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-employment-types

Example of how to list employment types using C#'s HttpClient. Replace `<TOKEN>` with your actual Bearer token.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class EmploymentTypesClient
{
    public static async Task ListEmploymentTypesAsync()
    {
        using (var client = new HttpClient())
        {
            client.BaseAddress = new Uri("https://rest.ripplingapis.com/");
            client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
            client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", "<TOKEN>");

            HttpResponseMessage response = await client.GetAsync("employment-types/");
            response.EnsureSuccessStatusCode();

            string responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        }
    }
}
```

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

### List Employment Types - Java Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-employment-types

Example of how to list employment types using Java's HttpClient. Replace `<TOKEN>` with your actual Bearer token.

```java
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class EmploymentTypesClient {

    public static void main(String[] args) throws IOException, InterruptedException {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://rest.ripplingapis.com/employment-types/"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer <TOKEN>")
                .GET()
                .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

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

### List Employment Types - Go Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-employment-types

Example of how to list employment types using Go's net/http package. Replace `<TOKEN>` with your actual Bearer token.

```go
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://rest.ripplingapis.com/employment-types/"

	client := &http.Client{}
	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		fmt.Println(err)
		return
	}

	req.Header.Add("Accept", "application/json")
	req.Header.Add("Authorization", "Bearer <TOKEN>")

	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}

	defer res.Body.Close()
	body, err := ioutil.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err)
		return
	}

	fmt.Println(string(body))
}
```

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

### Expand API Call Example

Source: https://developer.rippling.com/documentation/rest-api/guides/hris-getting-started

To get more detailed information in your API response, use the `expand` parameter. This example shows how to include user information when retrieving workers.

```curl
GET 'https://rest.ripplingapis.com/workers/?expand=user'
```

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

### List Employment Types - PowerShell Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-employment-types

Example of how to list employment types using PowerShell. Replace `<TOKEN>` with your actual Bearer token.

```powershell
Invoke-RestMethod -Uri "https://rest.ripplingapis.com/employment-types/" -Method Get -Headers @{
    "Accept" = "application/json"
    "Authorization" = "Bearer <TOKEN>"
}
```

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

### Example Request using cURL

Source: https://developer.rippling.com/documentation/rest-api/reference/get-employment-types

This cURL command demonstrates how to make a GET request to retrieve a specific employment type. Replace ':id' with the actual employment type ID and '<TOKEN>' with your valid Bearer token.

```curl
curl -L -X GET 'https://rest.ripplingapis.com/employment-types/:id/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

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

### User Object Example

Source: https://developer.rippling.com/documentation/rest-api/reference/get-users

This is an example of the JSON object returned when retrieving user data. It includes metadata, user identifiers, names, contact information, and status.

```json
{
  "__meta": {
    "redacted_fields": [
      {
        "name": "date_of_birth",
        "reason": "Insufficient entitlements"
      }
    ]
  },
  "id": "string",
  "created_at": "string",
  "updated_at": "string",
  "active": false,
  "username": "string",
  "name": {
    "formatted": "string",
    "given_name": "string",
    "middle_name": "string",
    "family_name": "string",
    "preferred_given_name": "string",
    "preferred_family_name": "string"
  },
  "display_name": "string",
  "emails": [
    {
      "value": "string",
      "type": "HOME",
      "display": "string"
    }
  ],
  "phone_numbers": [
    {
      "value": "string",
      "type": "HOME",
      "display": "string"
    }
  ],
  "addresses": [
    {
      "type": "HOME",
      "formatted": "string",

```

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

### List Employment Types - Node.js Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-employment-types

Example of how to list employment types using Node.js with the built-in https module. Replace `<TOKEN>` with your actual Bearer token.

```nodejs
const https = require('https');

const options = {
  hostname: 'rest.ripplingapis.com',
  port: 443,
  path: '/employment-types/',
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Authorization': 'Bearer <TOKEN>'
  }
};

const req = https.request(options, (res) => {
  console.log('statusCode:', res.statusCode);
  console.log('headers:', res.headers);

  let data = '';
  res.on('data', (chunk) => {
    data += chunk;
  });

  res.on('end', () => {
    console.log(JSON.parse(data));
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.end();
```

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

### List Employment Types - CURL Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-employment-types

Example of how to list employment types using cURL. Ensure you replace `<TOKEN>` with your actual Bearer token.

```curl
curl -L -X GET 'https://rest.ripplingapis.com/employment-types/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

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

### List Employment Types - PHP Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-employment-types

Example of how to list employment types using PHP's cURL extension. Replace `<TOKEN>` with your actual Bearer token.

```php
<?php

$url = "https://rest.ripplingapis.com/employment-types/";

$headers = [
    "Accept: application/json",
    "Authorization: Bearer <TOKEN>"
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Curl error: ' . curl_error($ch);
}

curl_close($ch);

echo $response;

?>
```

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

### Fetch All Functions (GET)

Source: https://developer.rippling.com/documentation/rest-api/guides/functions

Use GET List functions to return a paginated list of all functions for a given company. This is useful for retrieving existing function configurations.

```http
GET 'https://rest.ripplingapis.com/functions/'
```

```json
{
  "results": [
    {
      "id": "67af9fdd968c13ed38b352f2",
      "created_at": "2025-02-14T19:56:13.972000+00:00",
      "updated_at": "2025-12-18T23:25:07.197000+00:00",
      "name": "Test",
      "api_name": "test",
      "description": "",
      "code_draft": "{\n    \"object_api_name\": \"pet__c\",\n    \"record_ids\": [\"<object_id>\", \"<object_id>\"],\n    \"current_user\": \"<object_id>\",\n    \"app_id\": \"<object_id>\",\n    \"list_view_id\": \"<object_id>\",\n    \"page_id\": \"<object_id>\",\n    \"button\": \"my_cool_button\",\n    \"url\": \"https://app.rippling.com/custom-apps/objects/rto_expectation__c?app=rto_hub\", 
    \"trigger_type\": \"list view\",\n}",
      "dependencies": {}
    }
  ],
  "next_link": null
}
```

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

### List Custom Objects Response Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-custom-objects

This is an example of a successful JSON response when listing custom objects. It includes details about each custom object and a link for pagination.

```json
{
  "results": [
    {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "name": "string",
      "description": "string",
      "api_name": "string",
      "plural_label": "string",
      "category_id": "string",
      "native_category_id": "string",
      "managed_package_install_id": "string",
      "enable_history": false,
      "owner_id": "string"
    }
  ],
  "next_link": "string"
}
```

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

### Example Response for GET List compensations

Source: https://developer.rippling.com/documentation/rest-api/guides/hris-getting-started

This is an example JSON response when calling the GET List compensations endpoint. It includes details for each compensation record, such as ID, worker ID, and compensation amounts.

```json
{
  "results": [
    {
      "id": "65699284fb7bc7c3510f452b",
      "created_at": "2023-12-01T08:00:04.090000+00:00",
      "updated_at": "2025-11-23T08:28:35.124000+00:00",
      "worker_id": "65699281fb7bc7c3510f44a6",
      "worker": null,
      "annual_compensation": {
        "currency_type": "USD",
        "value": 250000
      },
      "annual_salary_equivalent": null,
      "hourly_wage": {
        "currency_type": "USD",
        "value": 120.19
      },
      "monthly_compensation": {
        "currency_type": "USD",
        "value": 20833.33
      }
}
],
}
```

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

### Onboarding Step Instructions

Source: https://developer.rippling.com/documentation/rest-api/reference/rippling-platform-api

Read onboarding step instructions via Onboarding.

```APIDOC
## onboarding-steps:instruction.read

### Description
Read onboarding step instructions via Onboarding.

### Method
GET

### Endpoint
/onboarding-steps/instructions
```

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

### Authenticated Request Example

Source: https://developer.rippling.com/documentation/rest-api/essentials/api-tokens

Example of how to make an authenticated GET request to the /users endpoint using an API token.

```APIDOC
## Authenticated Request Example

### Description
This example demonstrates how to authenticate a request to the `/users` endpoint using an API token.

### Method
GET

### Endpoint
`https://rest.ripplingapis.com/users`

### Headers
- `accept`: `application/json`
- `Authorization`: `Bearer UOCgmwb.....`
```

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

### Starter Package Folder Structure

Source: https://developer.rippling.com/flux/tools/starter_package

Illustrates the default directory and file layout for a Flux starter package, highlighting key files such as manifest.json and implementation.py.

```plaintext
app  
│   __init__.py  
│   manifest.json  
│  
└───kit  
│   │   __init__.py  
│   │  
│   └───capabilities  
│       │   __init__.py  
│       │  
│       └───capability  
│           │   implementation.py  
│           │  
│           └───test // it contains unit test cases  
│               │     

```

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

### Example Response for GET List Workers with Custom Fields

Source: https://developer.rippling.com/documentation/rest-api/guides/custom-fields-api

This is an example of the JSON response you will receive when calling the GET List Workers API with the `expand=custom_fields` parameter. It includes the custom field `employee_is_manager_api` which will show 'True' or 'False' based on the employee's manager status.

```json
{
  "data": [
    {
      "id": "worker_id_1",
      "first_name": "Jane",
      "last_name": "Doe",
      "custom_fields": {
        "employee_is_manager_api": "False"
      }
    },
    {
      "id": "worker_id_2",
      "first_name": "John",
      "last_name": "Smith",
      "custom_fields": {
        "employee_is_manager_api": "True"
      }
    }
  ],
  "has_more": false
}
```

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

### Onboarding Step Review

Source: https://developer.rippling.com/documentation/rest-api/reference/rippling-platform-api

Run review queries and complete review-type onboarding steps via Onboarding.

```APIDOC
## onboarding-steps:review.read-write

### Description
Run review queries and complete review-type onboarding steps via Onboarding.

### Method
GET, POST, PUT (Implied by read-write scope)

### Endpoint
/onboarding-steps/review
```

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

### GET List Departments API Call

Source: https://developer.rippling.com/documentation/rest-api/guides/org-data-getting-started

This example demonstrates how to call the GET List departments endpoint using curl. Ensure you have the correct authorization token and accept headers.

```bash
curl -L -X GET 'https://rest.ripplingapis.com/departments' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer REDACTED'
```

```json
{
  "results": [
    {
      "id": "65699295fb7bc7c3510f4075",
      "created_at": "2023-12-01T08:00:21.551000+00:00",
      "updated_at": "2025-04-20T13:50:50.632000+00:00",
      "name": "Sales",
      "parent_id": null,
      "parent": null,
      "reference_code": "10f4075",
      "department_hierarchy_id": [
        "65699295fb7bc7c3510f4075"
      ],
      "department_hierarchy": null
    }
 ],
  "next_link": null
}
```

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

### List Job Functions using cURL

Source: https://developer.rippling.com/documentation/rest-api/reference/list-job-functions

This example demonstrates how to list job functions using a cURL command. Ensure you replace `<TOKEN>` with your actual Bearer token for authorization.

```curl
curl -L -X GET 'https://rest.ripplingapis.com/job-functions/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

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

### Call GET List custom fields API

Source: https://developer.rippling.com/documentation/rest-api/guides/data-getting-started

This example demonstrates how to call the GET List custom fields endpoint using curl. Ensure you have the correct authorization token and accept headers.

```bash
curl -L -X GET 'https://rest.ripplingapis.com/custom-fields' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer REDACTED'
```

```json
{
  "results": [
    {
      "id": "66a7d17398f2ee7f0d2aa787",
      "created_at": "2024-07-29T17:29:21.584000+00:00",
      "updated_at": "2024-07-29T17:29:21.588000+00:00",
      "name": "Color",
      "description": null,
      "required": false,
      "type": "TEXT"
    },
    {
      "id": "67327d73417c02d7c10fb626",
      "created_at": "2024-11-11T21:56:02.098000+00:00",
      "updated_at": "2024-11-11T21:56:02.101000+00:00",
      "name": "Choice Field 2",
      "description": null,
      "required": false,
      "type": "RADIO"
    }
  ],
  "next_link": null
}
```

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

### GET List compensation bands details API Call

Source: https://developer.rippling.com/documentation/rest-api/guides/talent-getting-started

This example demonstrates how to call the GET List compensation bands details endpoint using curl. Ensure you have the necessary 'compensation-bands-details.read' scope and replace 'REDACTED' with your actual API token.

```curl
curl -L -X GET 'https://rest.ripplingapis.com/compensation-bands-details' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer REDACTED'
```

```json
{
  "results": [
    {
      "id": "667c578f847b97e5407e93b0",
      "created_at": "2024-06-26T18:01:51.787000+00:00",
      "updated_at": "2024-06-26T18:01:51.788000+00:00",
      "internal_job_code": null,
      "worker_id": "66759ebda4acbe76b80b255f",
      "worker": null
    }
  ],
  "next_link": null
}
```

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

### Update Work Location using Node.js

Source: https://developer.rippling.com/documentation/rest-api/reference/update-work-locations

Example of how to update a work location using Node.js with the 'axios' library. Ensure 'axios' is installed.

```nodejs
const axios = require('axios');

const url = `https://rest.ripplingapis.com/work-locations/{id}/`;

const data = {
    "name": "string",
    "address": {
        "type": "HOME",
        "street_address": "string",
        "locality": "string",
        "region": "string",
        "postal_code": "string",
        "country": "AF"
    }
};

const headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
};

axios.patch(url, data, { headers: headers })
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error(error);
    });
```

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

### List Departments

Source: https://developer.rippling.com/documentation/rest-api/reference/list-departments

This example shows how to list all departments in the organization using cURL. Ensure you replace `<TOKEN>` with your actual Bearer Token.

```curl
curl -L -X GET 'https://rest.ripplingapis.com/departments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

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

### GET List departments

Source: https://developer.rippling.com/documentation/rest-api/guides/org-data-getting-started

This example demonstrates how to retrieve a list of all departments within the organization. Ensure your API token has the necessary scopes for accessing department data.

```APIDOC
## GET List departments

### Description
Retrieves a list of all departments.

### Method
GET

### Endpoint
https://rest.ripplingapis.com/departments

### Request Example
```bash
curl -L -X GET 'https://rest.ripplingapis.com/departments' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer REDACTED'
```

### Response
#### Success Response (200)
- **results** (array) - A list of department objects.
  - **id** (string) - The unique identifier for the department.
  - **created_at** (string) - The timestamp when the department was created.
  - **updated_at** (string) - The timestamp when the department was last updated.
  - **name** (string) - The name of the department.
  - **parent_id** (string) - The ID of the parent department, if any.
  - **parent** (object) - The parent department object, if any.
  - **reference_code** (string) - A reference code for the department.
  - **department_hierarchy_id** (array) - An array of IDs representing the department's hierarchy.
  - **department_hierarchy** (object) - The department hierarchy object, if any.
- **next_link** (string) - A link to the next page of results, if available.

### Response Example
```json
{
  "results": [
    {
      "id": "65699295fb7bc7c3510f4075",
      "created_at": "2023-12-01T08:00:21.551000+00:00",
      "updated_at": "2025-04-20T13:50:50.632000+00:00",
      "name": "Sales",
      "parent_id": null,
      "parent": null,
      "reference_code": "10f4075",
      "department_hierarchy_id": [
        "65699295fb7bc7c3510f4075"
      ],
      "department_hierarchy": null
    }
 ],
  "next_link": null
}
```
```

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

### Onboarding Step Skip

Source: https://developer.rippling.com/documentation/rest-api/reference/rippling-platform-api

Skip onboarding steps via Onboarding.

```APIDOC
## onboarding-steps:skip.read-write

### Description
Skip onboarding steps via Onboarding.

### Method
POST, PUT (Implied by read-write scope)

### Endpoint
/onboarding-steps/skip
```

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

### Update Work Location using Python

Source: https://developer.rippling.com/documentation/rest-api/reference/update-work-locations

Example of how to update a work location using Python's requests library. Ensure you have the 'requests' library installed.

```python
import requests

url = "https://rest.ripplingapis.com/work-locations/{id}/"

payload = {
    "name": "string",
    "address": {
        "type": "HOME",
        "street_address": "string",
        "locality": "string",
        "region": "string",
        "postal_code": "string",
        "country": "AF"
    }
}
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.request("PATCH", url, json=payload, headers=headers)

print(response.text)
```

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

### List Employment Types - Ruby Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-employment-types

Example of how to list employment types using Ruby's Net::HTTP library. Replace `<TOKEN>` with your actual Bearer token.

```ruby
require 'uri'
require 'net/http'

uri = URI.parse("https://rest.ripplingapis.com/employment-types/")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.request_uri)
request["Accept"] = "application/json"
request["Authorization"] = "Bearer <TOKEN>"

response = http.request(request)
puts response.body
```

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

### Authenticated Request Example

Source: https://developer.rippling.com/documentation/rest-api

Demonstrates how to make an authenticated GET request to the users endpoint using curl. Ensure you replace 'UOCgmwb.....' with your actual API token.

```curl
curl -X 'GET' \
  'https://rest.ripplingapis.com/users' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer UOCgmwb.....'
```

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

### Onboarding Step Submission

Source: https://developer.rippling.com/documentation/rest-api/reference/rippling-platform-api

Submit data to onboarding steps via Onboarding.

```APIDOC
## onboarding-steps:submit.read-write

### Description
Submit data to onboarding steps via Onboarding.

### Method
POST, PUT (Implied by read-write scope)

### Endpoint
/onboarding-steps/submit
```

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

### List Work Locations Request (cURL)

Source: https://developer.rippling.com/documentation/rest-api/reference/list-work-locations

Example of how to make a GET request to the work locations endpoint using cURL. Ensure you replace `<TOKEN>` with your actual Bearer token.

```curl
curl -L -X GET 'https://rest.ripplingapis.com/work-locations/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

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

### List Users API Response Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-users

This is an example of a successful response (200 OK) when listing users. It includes metadata and a list of user results, with potential redactions for sensitive information.

```json
{
  "__meta": {
    "redacted_fields": [
      {
        "name": "date_of_birth",
        "reason": "Insufficient entitlements"
      }
    ]
  },
  "results": [
    {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "active": false,
      "username": "string",
      "name": {
        "formatted": "string",
        "given_name": "string",
        "middle_name": "string",
        "family_name": "string",
        "preferred_given_name": "string",
        "preferred_family_name": "string"
      },
      "display_name": "string",
      "emails": [
        {
          "value": "string",
          "type": "HOME",
          "display": "string"
        }
      ]
    }
  ]
}
```

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

### List Employment Types - Python Example

Source: https://developer.rippling.com/documentation/rest-api/reference/list-employment-types

Example of how to list employment types using Python's requests library. Replace `<TOKEN>` with your actual Bearer token.

```python
import requests

url = "https://rest.ripplingapis.com/employment-types/"

headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <TOKEN>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

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

### List Custom Fields API Request Example (cURL)

Source: https://developer.rippling.com/documentation/rest-api/reference/list-custom-fields

Use this cURL command to make a GET request to the custom fields endpoint. Ensure you replace `<TOKEN>` with your actual Bearer token.

```curl
curl -L -X GET 'https://rest.ripplingapis.com/custom-fields/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```