Get an autoresponder by id

GET

/openapi/autoresponder/{id}

const url = 'https://open-api.replyco.com/openapi/autoresponder/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://open-api.replyco.com/openapi/autoresponder/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns a single autoresponder with its condition and schedule. The response shape matches the body you send to create or update one (plus server-assigned ids), so you can fetch it, modify it, and PUT it back.

Note: the Open API models an autoresponder with one trigger condition. An autoresponder created in the app with several conditions is shown here by its first condition.

Authorizations

Bearer

Parameters

Path Parameters

required

string format: uuid

The id of the autoresponder.

Responses

200

Returns the autoresponder.

application/json

An autoresponder: when an incoming message on a linked integration matches the trigger conditions (and the schedule allows), the linked template is sent back automatically.

object

Unique identifier of the autoresponder.

string format: uuid

name

Human-readable name.

string

nullable

templateId

Id of the template sent as the reply.

string format: uuid

accountIds

Ids of the integrations (accounts) this autoresponder applies to.

Array<string>

nullable

condition

A trigger condition for an autoresponder.

object

Unique identifier of the condition.

string format: uuid

target

integer format: int32

Allowed values: 1 - Sender 2 - Subject 4 - Body 8 - Language 16 - ClientName

mode

integer format: int32

Allowed values: 0 - Contain 1 - NotContain 2 - StartWith 3 - EndWith 4 - Equals 5 - Between

value

Value(s) to match. Multiple values may be separated by semicolons and any match fires the autoresponder.

string

nullable

delay

Fixed delay (minutes) before sending; used when delayInRange is false.

integer format: int32

nullable

delayHours

Hours component added to delay.

integer format: int32

nullable

delayInRange

When true, a random delay between delayRangeFrom and delayRangeTo is used.

boolean

delayRangeFrom

Minimum delay (minutes) when delayInRange is true.

integer format: int32

nullable

delayRangeTo

Maximum delay (minutes) when delayInRange is true.

integer format: int32

nullable

delayRangeToHours

Hours component added to delayRangeTo.

integer format: int32

nullable

startTime

Start of the active time-of-day window (HH:MM:SS).

string format: date-span

endTime

End of the active time-of-day window (HH:MM:SS).

string format: date-span

isActiveTimeRanged

When true, only send within the StartTime–EndTime window.

boolean

weekdays

Days of week the autoresponder is active: 0=Sunday … 6=Saturday.

Array<integer>

nullable

startDate

First active date. If equal to endDate, the autoresponder is always active (no date restriction).

string format: date-time

endDate

Last active date.

string format: date-time

priority

Execution priority when multiple autoresponders match; lower runs first.

integer format: int32

frequency

integer format: int32

Allowed values: 0 - Once 1 - Continuous

inActive

When true the autoresponder is disabled.

boolean

isSendOutsideWorkingHours

When true, only send when the message arrives outside the company’s working hours.

boolean

Example

{
  "condition": {
    "target": "1 - Sender",
    "mode": "0 - Contain"
  },
  "frequency": "0 - Once"
}

401

User is not authenticated or authorized.

404

No autoresponder with the given id exists.