# Test whether an array holds a value

`POST /v1/check/array/has/value`

Returns true or false and how many items match. Compare exactly, or by text (contains, starts with, ends with), optionally ignoring case and surrounding spaces. For an array of objects pick the property to compare; an object without it never matches.

## Request body

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| key | string | no | For an array of objects, the property to compare (a dotted path such as owner.email reaches into nested objects). An object without it never matches |
| match | one of: exact, contains, starts_with, ends_with | no | exact, contains, starts_with or ends_with (default `"exact"`) |
| ignore_case | boolean | no | Treat text that differs only by upper and lower case as equal (default `false`) |
| trim | boolean | no | Ignore spaces around text when comparing (default `false`) |
| items | array of any | yes | The array |
| value | any | yes | The value to look for |

## Example request

A request body that works, as JSON.

```json
{
  "items": [
    "paid",
    "sent",
    "void"
  ],
  "value": "sent"
}
```

## Code samples

Replace YOUR_TOKEN with your access token.

### curl

```shell
curl -X POST 'https://api.skillfulsardine.com/v1/check/array/has/value' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "items": [
    "paid",
    "sent",
    "void"
  ],
  "value": "sent"
}'
```

### PowerShell

```powershell
$body = @'
{
  "items": [
    "paid",
    "sent",
    "void"
  ],
  "value": "sent"
}
'@
$response = Invoke-RestMethod -Method Post -Uri 'https://api.skillfulsardine.com/v1/check/array/has/value' `
  -Headers @{ Authorization = 'Bearer YOUR_TOKEN' } `
  -ContentType 'application/json; charset=utf-8' `
  -Body ([System.Text.Encoding]::UTF8.GetBytes($body))
$response | ConvertTo-Json -Depth 10
```

### Python

```python
import requests

payload = {
    "items": [
        "paid",
        "sent",
        "void",
    ],
    "value": "sent",
}

response = requests.post(
    "https://api.skillfulsardine.com/v1/check/array/has/value",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
    json=payload,
    timeout=30,
)
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.skillfulsardine.com/v1/check/array/has/value", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "items": [
    "paid",
    "sent",
    "void"
  ],
  "value": "sent"
}),
});
const result = await response.json();
console.log(result);
```

### Node

```javascript
// Node 18 or later. Save as call.mjs and run: API_TOKEN=... node call.mjs
const token = process.env.API_TOKEN;

const response = await fetch("https://api.skillfulsardine.com/v1/check/array/has/value", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "items": [
    "paid",
    "sent",
    "void"
  ],
  "value": "sent"
}),
});
const result = await response.json();
console.log(result);
```

### Rust

```rust
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
fn main() -> Result<(), Box<dyn std::error::Error>> {
    let body: serde_json::Value = serde_json::from_str(r#"{
  "items": [
    "paid",
    "sent",
    "void"
  ],
  "value": "sent"
}"#)?;
    let response = reqwest::blocking::Client::new()
        .post("https://api.skillfulsardine.com/v1/check/array/has/value")
        .bearer_auth("YOUR_TOKEN")
        .json(&body)
        .send()?;
    println!("{}", response.text()?);
    Ok(())
}
```

### Swift

```swift
import Foundation

var request = URLRequest(url: URL(string: "https://api.skillfulsardine.com/v1/check/array/has/value")!)
request.httpMethod = "POST"
request.setValue("Bearer YOUR_TOKEN", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = Data(#"""
{
  "items": [
    "paid",
    "sent",
    "void"
  ],
  "value": "sent"
}
"""#.utf8)

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))
```

## Response

The fields inside `data` of a successful response.

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| contains | boolean | yes | True when at least one item matches |
| match_count | integer | yes | How many items match |

## Example response

A real answer from the operation, as JSON. The fields in the table above are inside `data`.

```json
{
  "data": {
    "contains": true,
    "match_count": 1
  },
  "errors": null,
  "meta": {
    "request_id": "11455a88-59a0-4501-803f-cffb569f2d38",
    "timestamp": "2026-10-27T07:19:42.133019Z",
    "version": "2026-03-26"
  },
  "pagination": null
}
```

## Responses

| Status | When it happens |
| --- | --- |
| 200 | Successful Response |
| 400 | The body respects the operation schema, but the use case rejected it. Each problem is one ApiError entry |
| 413 | The request is larger than the request size limit of the API allows |
| 422 | The body does not respect the operation schema. Each problem is one ApiError entry with the code validation_error |
| 500 | Something failed inside the server and was not an input problem. The same envelope, errors may be empty |

---
Source: https://skillfulsardine.com/developers/api/array-contains/