Introduction

Welcome to the LeadPages Developer API documentation.

This API adheres to the LeadPages HTTP API Standards document.

Endpoints

/developer/v1

Public

/developer/v1/public

Apps

/developer/v1/public/apps

App

/developer/v1/public/apps/{uuid}

Request

GET /developer/v1/public/apps/{uuid}

View an App.

Body
Empty

Response

Body
`redirectUris`	`List[String]`
`_meta`	`Meta`
`name`	`String`
`clientId`	`String`
`logo`	`Regexp?(^data:image/(jpg\|jpeg\|png\|svg\+xml);base64,.+)` The App's logo as a data URI.
`homepage`	`URI`
`description`	`String`

Responses
`200 OK`

Errors
Empty

Apps

/developer/v1/apps

Request

GET /developer/v1/apps

Enumerate Apps.

Body
Empty

Query string
`cursor`	`String?`
`limit`	`Regexp?(\d+)`

Response

Body
`_items`	`List[App]`
`_meta`	`ListingMeta`

Responses
`200 OK`

Errors
`400 Bad Request`	`failed to parse JSON request`
`400 Bad Request`	`bad content type`
`400 Bad Request`	`missing Content-Type header`

Request

POST /developer/v1/apps

Enumerate Apps.

Body
`logo`	`Regexp?(^data:image/(jpg\|jpeg\|png\|svg\+xml);base64,.+)` The App's logo as a data URI.
`redirectUris`	`List[String]`
`homepage`	`URI`
`name`	`String`
`description`	`String`

Response

Body
`redirectUris`	`List[String]`
`_meta`	`Meta`
`name`	`String`
`clientId`	`String`
`clientSecret`	`String`
`logo`	`Regexp?(^data:image/(jpg\|jpeg\|png\|svg\+xml);base64,.+)` The App's logo as a data URI.
`homepage`	`URI`
`description`	`String`

Responses
`200 OK`

Errors
`400 Bad Request`	`failed to parse JSON request`
`400 Bad Request`	`bad content type`
`400 Bad Request`	`missing Content-Type header`

App

/developer/v1/apps/{uuid}

Request

GET /developer/v1/apps/{uuid}

Fetch an App.

Body
Empty

Query string
`client_secret`	`String?`

Response

Body
`redirectUris`	`List[String]`
`_meta`	`Meta`
`name`	`String`
`clientId`	`String`
`clientSecret`	`String`
`logo`	`Regexp?(^data:image/(jpg\|jpeg\|png\|svg\+xml);base64,.+)` The App's logo as a data URI.
`homepage`	`URI`
`description`	`String`

Responses
`200 OK`

Errors
`400 Bad Request`	`failed to parse JSON request`
`400 Bad Request`	`bad content type`
`400 Bad Request`	`missing Content-Type header`
`403 Forbidden`	`forbidden`
`404 Not Found`	`App '{}' does not exist.`

Request

PUT /developer/v1/apps/{uuid}

Update an App.

Body
`logo`	`Regexp?(^data:image/(jpg\|jpeg\|png\|svg\+xml);base64,.+)` The App's logo as a data URI.
`redirectUris`	`List[String]`
`homepage`	`URI`
`name`	`String`
`description`	`String`

Response

Body
`redirectUris`	`List[String]`
`_meta`	`Meta`
`name`	`String`
`clientId`	`String`
`clientSecret`	`String`
`logo`	`Regexp?(^data:image/(jpg\|jpeg\|png\|svg\+xml);base64,.+)` The App's logo as a data URI.
`homepage`	`URI`
`description`	`String`

Responses
`200 OK`

Errors
`400 Bad Request`	`failed to parse JSON request`
`400 Bad Request`	`bad content type`
`400 Bad Request`	`missing Content-Type header`
`404 Not Found`	`App '{}' does not exist.`

Ping

/developer/v1/ping

http GET http://dockerhost:8011/developer/v1/ping

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

Request

GET /developer/v1/ping

Body
Empty

Response

Body
`_meta.version`	`String`
`_meta`	`Dictionary`

Responses
`200 OK`

Errors
Empty

Definitions

Meta
`updated`	`DateTime`
`created`	`DateTime`
`uri`	`String`
`id`	`String`

App

App
`redirectUris`	`List[String]`
`_meta`	`Meta`
`description`	`String`
`clientId`	`String`
`clientSecret`	`String`
`logo`	`Regexp?(^data:image/(jpg\|jpeg\|png\|svg\+xml);base64,.+)` The App's logo as a data URI.
`homepage`	`URI`
`name`	`String`

ListingMeta

ListingMeta
`count`	`Integer`
`cursor`	`String?`
`total`	`Integer?`
`limit`	`Integer`