HydraCore
API by router

Platform forms

List Forms

GET
/v1/forms

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Query Parameters

status?string|null

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://example.com/v1/forms'
Example Response
[  {    "created_at": "2019-08-24T14:15:22Z",    "description": "string",    "entity_definition_id": "f5e56f39-8997-4d0b-8c9c-2dbcc2c88316",    "form_config": {},    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "slug": "string",    "status": "string",    "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",    "updated_at": "2019-08-24T14:15:22Z"  }]

Create Form

POST
/v1/forms

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
description?string|null
entity_definition_id?|null
form_config?
name*Name
Lengthlength <= 200
slug*Slug
Lengthlength <= 100
status?Status
Default"active"

Response Body

Successful Response

application/json
  1. response
created_at*Created At
Formatdate-time
description*string|null
entity_definition_id*|null
form_config*
id*Id
Formatuuid
name*Name
slug*Slug
status*Status
tenant_id*Tenant Id
Formatuuid
updated_at*Updated At
Formatdate-time
Example Request
curl -X POST 'https://example.com/v1/forms' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "slug": "string"}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "entity_definition_id": "f5e56f39-8997-4d0b-8c9c-2dbcc2c88316",  "form_config": {},  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "slug": "string",  "status": "string",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "updated_at": "2019-08-24T14:15:22Z"}

Get Form

GET
/v1/forms/{form_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

form_id*Form Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
created_at*Created At
Formatdate-time
description*string|null
entity_definition_id*|null
form_config*
id*Id
Formatuuid
name*Name
slug*Slug
status*Status
tenant_id*Tenant Id
Formatuuid
updated_at*Updated At
Formatdate-time
Example Request
curl -X GET 'https://example.com/v1/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "entity_definition_id": "f5e56f39-8997-4d0b-8c9c-2dbcc2c88316",  "form_config": {},  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "slug": "string",  "status": "string",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "updated_at": "2019-08-24T14:15:22Z"}

Delete Form

DELETE
/v1/forms/{form_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

form_id*Form Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/v1/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

Update Form

PUT
/v1/forms/{form_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

form_id*Form Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
description?string|null
entity_definition_id?|null
form_config?|null
name?string|null
status?string|null

Response Body

Successful Response

application/json
  1. response
created_at*Created At
Formatdate-time
description*string|null
entity_definition_id*|null
form_config*
id*Id
Formatuuid
name*Name
slug*Slug
status*Status
tenant_id*Tenant Id
Formatuuid
updated_at*Updated At
Formatdate-time
Example Request
curl -X PUT 'https://example.com/v1/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "entity_definition_id": "f5e56f39-8997-4d0b-8c9c-2dbcc2c88316",  "form_config": {},  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "slug": "string",  "status": "string",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "updated_at": "2019-08-24T14:15:22Z"}

Pin confirmation internal

Previous Page

Platform forms internal

Next Page