action callfire_get_keyword_lease { label: "Find a specific lease" description: "Searches for all keywords owned by user" provider: callfire method: GET path: "/keywords/leases/{keyword}" encoding: json input: { type: "object" properties: { fields: { type: "string" } keyword: { type: "string" } } required: ["keyword"] additionalProperties: false } output: { type: "object" description: "Represents a lease object for a given keyword" properties: { autoRenew: { type: "boolean" description: "Enables the auto renewal of a keyword lease at the end of each billing cycle" } contactListId: { type: "integer" format: "int64" description: "Existing contact list ID" } doubleOptInEnabled: { type: "boolean" description: "Enable/disable double opt in feature" } keyword: { type: "string" description: "A text used as a keyword" } labels: { type: "array" description: "~" items: { type: "string" } } leaseBegin: { type: "integer" format: "int64" description: "A time of a lease timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT" } leaseEnd: { type: "integer" format: "int64" description: "A date and time when the keyword lease is finishes. Timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000" } number: { type: "string" description: "A number assigned to keyword. Example: 12132212344" } optInConfirmationMessage: { type: "string" description: "Opt in confirmation message" } shortCode: { type: "string" description: "A short code assigned to keyword. Example: 67076 (Deprecated - please use number instead)" } status: { type: "string" description: "A lease status. Available values: PENDING, ACTIVE, RELEASED, UNAVAILABLE" enum: ["PENDING", "ACTIVE", "RELEASED", "UNAVAILABLE"] } type: { type: "string" description: "~" enum: ["PLAN", "EXTRA"] } } } }