List or filter playbooks

GET

https://api.close.com/api/v1/playbook/

GET

/api/v1/playbook/

$ curl https://api.close.com/api/v1/playbook/ \
>      -u "<CLOSE_API_KEY>:"

1 {
2   "data": [
3     {
4       "archived_at": null,
5       "archived_by_id": null,
6       "created_at": "2025-07-29T10:30:00.000000+00:00",
7       "created_by_id": "user_A6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
8       "custom_field_ids": [
9         "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
10         "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c"
11       ],
12       "description": "Initial discovery call with prospect.",
13       "id": "convtyp_03oUxZfoO6e2vHmcz1DiHR",
14       "name": "Discovery Call",
15       "organization_id": "orga_AbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
16       "outcome_ids": [
17         "outcome_030Xl5QwKi7tPRLRtnuef3",
18         "outcome_03oUxZfoO6e2vHmcz1DiHR"
19       ],
20       "position": 0,
21       "summary_guidance": "Summarize the prospect's pain points and next steps.",
22       "updated_at": "2025-07-29T10:30:00.000000+00:00",
23       "updated_by_id": "user_A6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
24     }
25   ],
26   "has_more": false
27 }

Fetch a list of playbooks for the organization. Results are sorted by position ascending.

curl https://api.close.com/api/v1/playbook/ \
     -u "<CLOSE_API_KEY>:"

{
  "data": [
    {
      "archived_at": null,
      "archived_by_id": null,
      "created_at": "2025-07-29T10:30:00.000000+00:00",
      "created_by_id": "user_A6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "custom_field_ids": [
        "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
        "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c"
      ],
      "description": "Initial discovery call with prospect.",
      "id": "convtyp_03oUxZfoO6e2vHmcz1DiHR",
      "name": "Discovery Call",
      "organization_id": "orga_AbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "outcome_ids": [
        "outcome_030Xl5QwKi7tPRLRtnuef3",
        "outcome_03oUxZfoO6e2vHmcz1DiHR"
      ],
      "position": 0,
      "summary_guidance": "Summarize the prospect's pain points and next steps.",
      "updated_at": "2025-07-29T10:30:00.000000+00:00",
      "updated_by_id": "user_A6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    }
  ],
  "has_more": false
}

Fetch a list of playbooks for the organization. Results are sorted by position ascending.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults to 0

Number of results to skip before returning, for pagination.

is_archivedboolean or nullOptional

Filter for archived or not-archived playbooks. When not provided, both archived and not-archived playbooks will be returned.

position__gtinteger or nullOptional

Filters for where the playbook’s position is greater than the given value.

created_at__ltdatetime or nullOptional

Filters for where the playbook’s created_at (creation date) is before the given value.

Response

Successful response

datalist of objects

has_moreboolean

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl https://api.close.com/api/v1/playbook/ \
>	-u "<CLOSE_API_KEY>:"

1	{
2	"data": [
3	{
4	"archived_at": null,
5	"archived_by_id": null,
6	"created_at": "2025-07-29T10:30:00.000000+00:00",
7	"created_by_id": "user_A6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
8	"custom_field_ids": [
9	"cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
10	"cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c"
11	],
12	"description": "Initial discovery call with prospect.",
13	"id": "convtyp_03oUxZfoO6e2vHmcz1DiHR",
14	"name": "Discovery Call",
15	"organization_id": "orga_AbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
16	"outcome_ids": [
17	"outcome_030Xl5QwKi7tPRLRtnuef3",
18	"outcome_03oUxZfoO6e2vHmcz1DiHR"
19	],
20	"position": 0,
21	"summary_guidance": "Summarize the prospect's pain points and next steps.",
22	"updated_at": "2025-07-29T10:30:00.000000+00:00",
23	"updated_by_id": "user_A6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
24	}
25	],
26	"has_more": false
27	}