> For the complete documentation index, see [llms.txt](https://docs.planetcrust.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.planetcrust.com/human-connections/bamboohr/bamboohr/action-api-request.md).

# Action: API Request

<p align="center"><a class="button primary" data-icon="circle-caret-right">Try @Human</a><a class="button primary" data-icon="check">Buy @Human Subscriptions</a><a class="button primary" data-icon="comments">Join @Human Community</a></p>

<figure><img src="/files/QfD5zyhzSwCXEmj0jifr" alt="" width="375"><figcaption></figcaption></figure>

<p align="center">The API Request action sends a custom API call to interact with BambooHR's system.</p>

{% embed url="<https://www.youtube.com/watch?v=CyuUuaBSZzA>" %}

#### Example User Story

I want to make API requests to BambooHR so that I can integrate employee data with other systems.

#### Fields

| Field Name | Field Type | Required |
| ---------- | ---------- | -------- |
| endpoint   | String     | Yes      |
| method     | String     | Yes      |
| body       | String     | No       |
| headers    | String     | No       |

### Related Connections

[BambooHR](/human-connections/bamboohr/bamboohr.md)

### Related Automations

Example link

### Code (Apache v2.0): Operation

```
{
  "handle": "api-request",
  "state": "inDev",
  "meta": {
    "short": "API Request",
    "description": "Make an API request to BambooHR"
  },
  "input": [
    {
      "name": "endpoint",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The BambooHR API endpoint to call"
      }
    },
    {
      "name": "method",
      "type": "String",
      "required": true,
      "meta": {
        "description": "HTTP method to use (GET, POST, PUT, PATCH, DELETE)"
      }
    },
    {
      "name": "body",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Request body for POST/PUT/PATCH requests"
      }
    },
    {
      "name": "headers",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Additional headers as JSON string"
      }
    }
  ],
  "output": [
    {
      "name": "response",
      "type": "String",
      "selector": ["body"],
      "meta": {
        "description": "Raw response from BambooHR API"
      }
    },
    {
      "name": "statusCode",
      "type": "Integer",
      "selector": ["status"],
      "meta": {
        "description": "HTTP status code of the response"
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "{{method}}",
        "path": "{{endpoint}}",
        "headers": {
          "Content-Type": "application/json",
          "Accept": "application/json",
          "{{#if headers}}{{headers}}{{/if}}": ""
        },
        "bodyTemplate": {
          "value": "{{#if body}}{{body}}{{/if}}"
        }
      }
    }
  ]
}

```

<p align="center"><a class="button primary" data-icon="square-caret-right">Try @Human</a><a class="button primary" data-icon="check">Buy @Human Subscription</a><a class="button primary" data-icon="comments">Join @Human Community</a></p>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.planetcrust.com/human-connections/bamboohr/bamboohr/action-api-request.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
