> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://support.atomicwork.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://support.atomicwork.com/_mcp/server.

# List custom objects with filtering and sorting

POST https://{tenant}.atomicwork.com/api/v1/custom-objects/{objectTypeId}/list
Content-Type: application/json

Reference: https://support.atomicwork.com/api-reference/atomicwork-public-api/custom-objects/postapi-v-1-custom-objects-object-type-id-list

## Authentication

- `X-Api-Key` header (required) — API Key authentication via header

## Request

### Path parameters

- `objectTypeId` (long, required) — The object type ID to scope results to

### Headers

- `X-Workspace-Id` (string, optional)

### Body (application/json)

This endpoint expects an object.

- `filters` (list of ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItems, optional) — Optional filter conditions
- `sort` (enum, optional) — Sort order for custom object list view results
  - Allowed values: `CREATED_AT_ASC`, `CREATED_AT_DESC`, `UPDATED_AT_ASC`, `UPDATED_AT_DESC`, `DISPLAY_ID_ASC`, `DISPLAY_ID_DESC`
- `scope` (enum, optional) — Scope of the object type (GLOBAL or WORKSPACE)
  - Allowed values: `GLOBAL`, `WORKSPACE`
- `workspace_id` (long, optional) — Workspace ID for cross-type queries. Required when scope=WORKSPACE in cross-type list calls (when objectTypeId is absent).
- `page` (integer, optional, default: 1) — Page number (1-based)
- `page_size` (integer, optional, default: 25) — Number of records per page

## Response

### 200

Successful response

## Types

### ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItems

Filter condition for the custom object list view. Extends BaseListFilterDTO using the standard attribute/operator/values pattern. The attribute field holds either a top-level field name (e.g. "display_id", "created_at"), a column_key for custom fields (e.g. "cf_shorttext_001"), or a custom field reference_key. For ID-shaped custom fields (relationship, entity-reference, dropdown, and multi-dropdown), value -1 or null means blank. Blank filters match indexed field slots with null/empty values, indexed slots containing the historical -1 sentinel, and records where the nested field slot does not exist.

- `attribute` (string, optional)
- `operator` (enum, optional)
  - Allowed values: `EQUALS`, `NOT_EQUALS`, `CONTAINS`, `NOT_CONTAINS`, `IN`, `NOT_IN`, `GREATER_THAN`, `LESS_THAN`, `GREATER_THAN_EQUALS`, `LESS_THAN_EQUALS`, `IS_BETWEEN`, `IS_NULL`, `IS_NOT_NULL`, `STARTS_WITH`, `ENDS_WITH`, `TEXT_CONTAINS`, `TEXT_DOES_NOT_CONTAINS`, `IS_ANY_OF`, `IS_NOT_ANY_OF`, `IS_EXACTLY`, `IS_ON_OR_BEFORE`, `IS_ON_OR_AFTER`, `IS_WITHIN`
- `values` (list of ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItems, optional)

### ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItems

- `value` (ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItemsValue, optional) — A bare scalar - number, string or boolean - never a JSON object or array. For relationship, entity-reference, or dropdown attributes pass the numeric option or entity id (e.g. 4009, not \{"id": 4009}).
- `nested_filter` (any, optional)

### ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItemsValue

A bare scalar - number, string or boolean - never a JSON object or array. For relationship, entity-reference, or dropdown attributes pass the numeric option or entity id (e.g. 4009, not \{"id": 4009}).

## Examples

**Request**

```json
{
  "filters": [
    {}
  ],
  "sort": "CREATED_AT_ASC",
  "scope": "GLOBAL",
  "workspace_id": 0,
  "page": 0,
  "page_size": 0
}
```

**Response**

```json
{}
```

**SDK Code**

```python Custom Objects_postapi_v1_custom_objects__objectTypeId__list_example
import requests

url = "https://{tenant}.atomicwork.com/api/v1/custom-objects/1/list"

payload = {
    "filters": [{}],
    "sort": "CREATED_AT_ASC",
    "scope": "GLOBAL",
    "workspace_id": 0,
    "page": 0,
    "page_size": 0
}
headers = {
    "X-Workspace-Id": "{{workspace_id}}",
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Custom Objects_postapi_v1_custom_objects__objectTypeId__list_example
const url = 'https://{tenant}.atomicwork.com/api/v1/custom-objects/1/list';
const options = {
  method: 'POST',
  headers: {
    'X-Workspace-Id': '{{workspace_id}}',
    'X-Api-Key': '<apiKey>',
    'Content-Type': 'application/json'
  },
  body: '{"filters":[{}],"sort":"CREATED_AT_ASC","scope":"GLOBAL","workspace_id":0,"page":0,"page_size":0}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Custom Objects_postapi_v1_custom_objects__objectTypeId__list_example
package main

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

func main() {

	url := "https://{tenant}.atomicwork.com/api/v1/custom-objects/1/list"

	payload := strings.NewReader("{\n  \"filters\": [\n    {}\n  ],\n  \"sort\": \"CREATED_AT_ASC\",\n  \"scope\": \"GLOBAL\",\n  \"workspace_id\": 0,\n  \"page\": 0,\n  \"page_size\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Workspace-Id", "{{workspace_id}}")
	req.Header.Add("X-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

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

url = URI("https://{tenant}.atomicwork.com/api/v1/custom-objects/1/list")

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

request = Net::HTTP::Post.new(url)
request["X-Workspace-Id"] = '{{workspace_id}}'
request["X-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": [\n    {}\n  ],\n  \"sort\": \"CREATED_AT_ASC\",\n  \"scope\": \"GLOBAL\",\n  \"workspace_id\": 0,\n  \"page\": 0,\n  \"page_size\": 0\n}"

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

```java Custom Objects_postapi_v1_custom_objects__objectTypeId__list_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://{tenant}.atomicwork.com/api/v1/custom-objects/1/list")
  .header("X-Workspace-Id", "{{workspace_id}}")
  .header("X-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": [\n    {}\n  ],\n  \"sort\": \"CREATED_AT_ASC\",\n  \"scope\": \"GLOBAL\",\n  \"workspace_id\": 0,\n  \"page\": 0,\n  \"page_size\": 0\n}")
  .asString();
```

```php Custom Objects_postapi_v1_custom_objects__objectTypeId__list_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://{tenant}.atomicwork.com/api/v1/custom-objects/1/list', [
  'body' => '{
  "filters": [
    {}
  ],
  "sort": "CREATED_AT_ASC",
  "scope": "GLOBAL",
  "workspace_id": 0,
  "page": 0,
  "page_size": 0
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Api-Key' => '<apiKey>',
    'X-Workspace-Id' => '{{workspace_id}}',
  ],
]);

echo $response->getBody();
```

```csharp Custom Objects_postapi_v1_custom_objects__objectTypeId__list_example
using RestSharp;

var client = new RestClient("https://{tenant}.atomicwork.com/api/v1/custom-objects/1/list");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Workspace-Id", "{{workspace_id}}");
request.AddHeader("X-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"filters\": [\n    {}\n  ],\n  \"sort\": \"CREATED_AT_ASC\",\n  \"scope\": \"GLOBAL\",\n  \"workspace_id\": 0,\n  \"page\": 0,\n  \"page_size\": 0\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Custom Objects_postapi_v1_custom_objects__objectTypeId__list_example
import Foundation

let headers = [
  "X-Workspace-Id": "{{workspace_id}}",
  "X-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "filters": [[]],
  "sort": "CREATED_AT_ASC",
  "scope": "GLOBAL",
  "workspace_id": 0,
  "page": 0,
  "page_size": 0
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{tenant}.atomicwork.com/api/v1/custom-objects/1/list")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```