Search Sequence

GET

GET

http://api.atzcrm.com/v1/sequence/search

Search sequences by entity type, sequence name, created date, updated date, sorting, and pagination.

Request

Query Parameters

• entity_typestring

  Optional. Allowed values: candidate, contact.

• searchstring

  Optional. Searches by sequence name.

• created_fromdate

  Optional. Format: YYYY-MM-DD. Returns sequences created on or after this date.

• created_todate

  Optional. Format: YYYY-MM-DD. Returns sequences created on or before this date.

• updated_fromdate

  Optional. Format: YYYY-MM-DD. Returns sequences updated on or after this date.

• updated_todate

  Optional. Format: YYYY-MM-DD. Returns sequences updated on or before this date.

• pageinteger

  Optional. Default: 1.

• limitinteger

  Optional. Default: 25. Maximum: 100.

• sort_bystring

  Optional. Allowed values: sequence_name, created_at, updated_at.

• sort_orderstring

  Optional. Allowed values: asc, desc.

Request Example

GET /v1/sequence/search?entity_type=candidate&search=welcome&page=1&limit=10&sort_by=sequence_name&sort_order=asc&created_from=2026-01-01&created_to=2026-05-25

Response

200

Body

• totalinteger

  Total matching records.

• per_pageinteger

  Number of records returned per page.

• current_pageinteger
• last_pageinteger
• next_page_urlstring|null
• prev_page_urlstring|null
• frominteger
• tointeger
• dataArray[object]

  Each object contains id, sequence_name, entity_type, created_at, and updated_at.

400

Body

• Validation errors

  Returned as an array of field level errors, or as an object when unknown query parameters are passed.

401

Body

• unauthorised

500

Body

• Error while searching sequences

Response Example

{
  "total": 2,
  "per_page": 10,
  "current_page": 1,
  "last_page": 1,
  "next_page_url": null,
  "prev_page_url": null,
  "from": 1,
  "to": 2,
  "data": [
    {
      "id": 101,
      "sequence_name": "Candidate Welcome Sequence",
      "entity_type": "candidate",
      "created_at": "2026-01-15T09:30:00.000Z",
      "updated_at": "2026-01-20T11:45:00.000Z"
    },
    {
      "id": 102,
      "sequence_name": "Candidate Follow Up Sequence",
      "entity_type": "candidate",
      "created_at": "2026-02-05T14:10:00.000Z",
      "updated_at": "2026-02-06T08:20:00.000Z"
    }
  ]
}

Validation Error Example

[
  {
    "field_name": "sort_by",
    "error_message": "sort_by must be one of: sequence_name, created_at, updated_at"
  }
]