---
title: "Create Process List Api"
method: POST
path: "/process-lists"
tags: ["Process Lists"]
---

# Create Process List Api

`POST /process-lists`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/process-lists`
- Auth: HTTP bearer

Create a process list: its object, its parent relationship and the marker, atomically. Requires
objects:manage and current Admin access, the same gate as ``POST /objects``. Add the list's fields with
``POST /objects/{slug}/attributes``.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ProcessListCreate
  - `api_slug` string, required
  - `singular_noun` string, required
  - `plural_noun` string, required
  - `description` string, nullable
  - `icon` 'box' | 'briefcase' | 'building' | 'calendar' | 'flag' | 'folder' | 'globe' | 'heart' | 'layers' | 'package' | 'target' | 'users', nullable
  - `parent` RelationshipTarget, required
    - `kind` 'custom' | 'contacts' | 'companies' | 'deals', required
    - `object_id` string, uuid, nullable
  - `parent_label` string, required
  - `entries_label` string, required

## Response `201`

Successful Response

- ApiResponseProcessListResponse
  - `data` ProcessListResponse, required
    - `id` string, uuid, required
    - `api_slug` string, required
    - `singular_noun` string, required
    - `plural_noun` string, required
    - `description` string, nullable
    - `icon` string, nullable
    - `display_attribute_slug` string, nullable
    - `is_archived` boolean, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `parent_relationship_definition_id` string, uuid, required
    - `parent_kind` 'custom' | 'contacts' | 'companies' | 'deals', required
    - `parent_object_id` string, uuid, nullable
    - `parent_object_slug` string, nullable
    - `parent_label` string, required
    - `entries_label` string, required
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)