NAV
HTTP

Introduction

Welcome to the LeadPages Dejavu API documentation.

This API adheres to the LeadPages HTTP API Standards document.

Endpoints

/leads/v1

Ping

/leads/v1/ping

A no-op endpoint that can be used to check what the currently-deployed version of the API is.

http GET http://dejavu.docker/leads/v1/ping

{
  "_meta": {
    "_version": "0.7.19"
  },
  "_status": {
    "code": 200
  }
}

Request

GET /leads/v1/ping

Get the currently-deployed version of the API.

Body
Empty

Response

Body
_meta._version String
The current internal version number of the API.
_meta Dictionary
Responses
200 OK
Errors
Empty

Exports

/leads/v1/exports

Request

GET /leads/v1/exports

Body
Empty
Query string
limit Regexp?(\d+)
The maximum number of items to return in the response.
cursor Regexp?(\d+)
A string representing where a previous request "left off"

Response

Body
_meta ListingMeta
Meta information about the response.
_items List[Export]
Responses
200 OK
Errors
Empty

Request

POST /leads/v1/exports

Body
start DateTime?
end DateTime?
contentUuid String?
formUuid String?
excludeSpam Boolean?
search String?
notifyEmail Email?
timezone String?
include List?[String]
exclude List?[String]
deleted Boolean?
spamOnly Boolean?

Response

Body
start DateTime?
end DateTime?
contentUuid String?
formUuid String?
excludeSpam Boolean?
search String?
notifyEmail Email?
timezone String?
include List?[String]
exclude List?[String]
deleted Boolean?
spamOnly Boolean?
_meta Meta
Meta information about the resource.
status String?
downloadUrl URI?
Responses
200 OK
Errors
Empty

Export

/leads/v1/exports/{uuid}

Request

GET /leads/v1/exports/{uuid}

Body
Empty

Response

Body
start DateTime?
end DateTime?
contentUuid String?
formUuid String?
excludeSpam Boolean?
search String?
notifyEmail Email?
timezone String?
include List?[String]
exclude List?[String]
deleted Boolean?
spamOnly Boolean?
_meta Meta
Meta information about the resource.
status String?
downloadUrl URI?
Responses
200 OK
Errors
404 Not Found export {uuid} not found

Request

DELETE /leads/v1/exports/{uuid}

Body
Empty

Response

Body
Empty
Responses
204 No Content
Errors
404 Not Found export {uuid} not found

Exportcsv

/leads/v1/exports/{uuid}.csv

Request

GET /leads/v1/exports/{uuid}.csv

Body
Empty

Response

Body
Empty
Responses
200 OK
Errors
404 Not Found export {uuid} not found

Forms

/leads/v1/forms

Request

GET /leads/v1/forms

Body
Empty
Query string
limit Regexp?(\d+)
The maximum number of items to return in the response.
cursor Regexp?(\d+)
A string representing where a previous request "left off"

Response

Body
_meta ListingMeta
Meta information about the response.
_items List[Form]
Responses
200 OK
Errors
Empty

Form

/leads/v1/forms/{uuid}

Request

GET /leads/v1/forms/{uuid}

Body
Empty

Response

Body
_meta Meta
Meta information about the resource.
name String
content_name String?
content_uuid String?
content_type String?
current_version String?
Responses
200 OK
Errors
404 Not Found form {uuid} not found

Request

PUT /leads/v1/forms/{uuid}

Body
name String
content_name String?
content_uuid String?
content_type String?
current_version String?
created DateTime
updated DateTime
deleted DateTime?
fields List[Field]

Response

Body
Empty
Responses
202 Accepted
Errors
Empty

Submissions

/leads/v1/submissions

Request

GET /leads/v1/submissions

Body
Empty
Query string
limit Regexp?(\d+)
The maximum number of items to return in the response.
cursor Regexp?(\d+)
A string representing where a previous request "left off"
start DateTime?
end DateTime?
content String?
form String?
excludeSpam Enum('true', 'True', 'yes', '1', 'on', 'false', 'False', 'no', '0', 'off')
search String?
orderBy String?
direction Enum('asc', 'desc')
deleted Enum('true', 'True', 'yes', '1', 'on', 'false', 'False', 'no', '0', 'off')
spamOnly Enum('true', 'True', 'yes', '1', 'on', 'false', 'False', 'no', '0', 'off')

Response

Body
_meta ListingMeta
Meta information about the response.
_items List[Submission]
Responses
200 OK
Errors
Empty

Request

PATCH /leads/v1/submissions

Body
include List[String]
data PatchSubmission
Query string
limit Regexp?(\d+)
The maximum number of items to return in the response.
cursor Regexp?(\d+)
A string representing where a previous request "left off"
start DateTime?
end DateTime?
content String?
form String?
excludeSpam Enum('true', 'True', 'yes', '1', 'on', 'false', 'False', 'no', '0', 'off')
search String?
orderBy String?
direction Enum('asc', 'desc')
deleted Enum('true', 'True', 'yes', '1', 'on', 'false', 'False', 'no', '0', 'off')
spamOnly Enum('true', 'True', 'yes', '1', 'on', 'false', 'False', 'no', '0', 'off')

Response

Body
Empty
Responses
202 Accepted
Errors
Empty

Request

DELETE /leads/v1/submissions

Body
include List[String]
deletionMethod Enum('soft', 'permanent')
Query string
limit Regexp?(\d+)
The maximum number of items to return in the response.
cursor Regexp?(\d+)
A string representing where a previous request "left off"
start DateTime?
end DateTime?
content String?
form String?
excludeSpam Enum('true', 'True', 'yes', '1', 'on', 'false', 'False', 'no', '0', 'off')
search String?
orderBy String?
direction Enum('asc', 'desc')
deleted Enum('true', 'True', 'yes', '1', 'on', 'false', 'False', 'no', '0', 'off')
spamOnly Enum('true', 'True', 'yes', '1', 'on', 'false', 'False', 'no', '0', 'off')

Response

Body
Empty
Responses
202 Accepted
Errors
Empty

Submission

/leads/v1/submissions/{uuid}

Request

GET /leads/v1/submissions/{uuid}

Body
Empty

Response

Body
_meta Meta
Meta information about the resource.
email String?
formUuid String
isBot Boolean?
data Dictionary
formName String?
contentName String?
contentType String?
contentUuid String?
deleted DateTime?
Responses
200 OK
Errors
404 Not Found submission {uuid} not found

Request

PUT /leads/v1/submissions/{uuid}

Body
email String?
form_uuid String?
form_version String?
is_bot Boolean?
created DateTime
data Dictionary
deleted DateTime?

Response

Body
Empty
Responses
202 Accepted
Errors
Empty

Definitions

Meta

Meta
id Or[String, Integer]
The resource's unique identifier.
uri String
The resource's absolute URI.
created DateTime
When the resource was created.
updated DateTime
When the resource was last updated.

ListingMeta

ListingMeta
limit Integer
The requested limit on the number of items.
total Integer?
The number of items in the database.
count Integer
The total number of items in the response.
cursor String?
This is used in conjunction with limit to paginate through lists of items.

Export

Export
start DateTime?
end DateTime?
contentUuid String?
formUuid String?
excludeSpam Boolean?
search String?
notifyEmail Email?
timezone String?
include List?[String]
exclude List?[String]
deleted Boolean?
spamOnly Boolean?
_meta Meta
Meta information about the resource.
status String?
downloadUrl URI?

Field

Field
name String
form_uuid String
form_version String?
kind String
label String
required Boolean

Form

Form
_meta Meta
Meta information about the resource.
name String
content_name String?
content_uuid String?
content_type String?
current_version String?

Submission

Submission
_meta Meta
Meta information about the resource.
email String?
formUuid String
isBot Boolean?
data Dictionary
formName String?
contentName String?
contentType String?
contentUuid String?
deleted DateTime?

PatchSubmission

PatchSubmission
deleted DateTime?
HTTP