CLclose
playbooks

List or filter playbooks

Changed on

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

get/playbook/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/playbook/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Query parameters

_limitinteger

Number of results to return.

_skipinteger

Number of results to skip before returning, for pagination.

is_archivedboolean nullable

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

position__gtinteger nullable

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

created_at__ltstring date-time nullable

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

Response

Successful response

has_moreboolean required

Changes

  • 7bdb9cfcca22Revision changes
    • breaking

      for the query request parameter _limit, default value was changed from 100 to 20

    • warning

      for the query request parameter _limit, the max was set to 100.00

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status