See the API's various operations for details on their request parameters and response data:
| Operation | Method | Endpoint |
|---|---|---|
| Settings | ||
| List API client settings | GET | /config/{app_id}/settings |
| Modify global settings | PUT | /config/{app_id}/settings |
| List application settings | GET | /config/{app_id}/settings/options |
| Entity Types | ||
| Get information about all your entity types | GET | /config/{app_id}/entityTypes |
| Get information about a specific entity type | GET | /config/{app_id}/entityTypes/{entity_type} |
| Get information about an entity type's attributes | GET | /config/{app_id}/entityTypes/{entity_type}/attributes |
| Get information about the specified entity type attribute | GET | /config/{app_id}/entityTypes/{entity_type}/attributes/{attribute_name} |
| Flows | ||
| List flows | GET | /config/{app_id}/flows |
| View a flow | GET | /config/{app_id}/flows/{flow} |
| Modify a flow | PUT | /config/{app_id}/flows/{flow} |
| Copy a flow | POST | /config/{app_id}/flows/{flow}/copy |
| List flow fields | GET | /config/{app_id}/flows/{flow}/fields |
| Add a field | POST | /config/{app_id}/flows/{flow}/fields |
| Remove a field from a flow | DELETE | /config/{app_id}/flows/{flow}/fields/{field} |
| Get a specific field | GET | /config/{app_id}/flows/{flow}/fields/{field} |
| Modify a field | PUT | /config/{app_id}/flows/{flow}/fields/{field} |
| List forms | GET | /config/{app_id}/flows/{flow}/forms |
| Create a form | POST | /config/{app_id}/flows/{flow}/forms |
| Delete a form | DELETE | /config/{app_id}/flows/{flow}/forms/{form} |
| View a form | GET | /config/{app_id}/flows/{flow}/forms/{form} |
| Modify a form | PUT | /config/{app_id}/flows/{flow}/forms/{form} |
| List your Hosted Login links | GET | /config/{app_id}/flows/{flow}/links |
| Create a Hosted Login link | POST | /config/{app_id}/flows/{flow}/links |
| View a Hosted Login link | GET | /config/{app_id}/flows/{flow}/links/{linkId} |
| Modify a Hosted Login link | PUT | /config/{app_id}/flows/{flow}/links/{linkId} |
| Delete a Hosted Login link | DELETE | /config/{app_id}/flows/{flow}/links/{linkId} |
| Get translation values | GET | /config/{app_id}/flows/{flow}/locales/{locale} |
| List your 2FA messages | GET | /config/{app_id}/flows/{flow}/locales/{locale}/2faMessages |
| Add the default 2FA messages to a flow | POST | /config/{app_id}/flows/{flow}/locales/{locale}/2faMessages |
| View a 2FA message | GET | /config/{app_id}/flows/{flow}/locales/{locale}/2faMessages/{messageId} |
| Modify a 2FA message | PUT | /config/{app_id}/flows/{flow}/locales/{locale}/2faMessages/{messageId} |
| Get information about the fields available for the specified flow | GET | /config/{app_id}/flows/{flow}/locales/{locale}/fields |
| Add a translatable field | POST | /config/{app_id}/flows/{flow}/locales/{locale}/fields |
| Get a translated field | GET | /config/{app_id}/flows/{flow}/locales/{locale}/fields/{field} |
| Modify a translatable field | PUT | /config/{app_id}/flows/{flow}/locales/{locale}/fields/{field} |
| List email templates | GET | /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates |
| View an email template | GET | /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template} |
| Modify an email template | PUT | /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template} |
| View the body of an email template | GET | /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/body |
| Modify the body of an email template | PUT | /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/body |
| Get the subject of an email template | GET | /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/subject |
| Modify the subject of an email template | PUT | /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/subject |
| List available strings per locale | GET | /config/{app_id}/flows/{flow}/locales/{locale}/strings |
| Create a localized string | POST | /config/{app_id}/flows/{flow}/locales/{locale}/strings |
| Delete a string per locale | DELETE | /config/{app_id}/flows/{flow}/locales/{locale}/strings/{string} |
| View a localized string | GET | /config/{app_id}/flows/{flow}/locales/{locale}/strings/{string} |
| Modify a localized string | PUT | /config/{app_id}/flows/{flow}/locales/{locale}/strings/{string} |
| Promote a flow | POST | /config/{app_id}/flows/{flow}/promote |
| List available screens | GET | /config/{app_id}/flows/{flow}/screens |
| Create screen | POST | /config/{app_id}/flows/{flow}/screens |
| Delete a screen | DELETE | /config/{app_id}/flows/{flow}/screens/{screen} |
| View a screen | GET | /config/{app_id}/flows/{flow}/screens/{screen} |
| Modify a screen | PUT | /config/{app_id}/flows/{flow}/screens/{screen} |
| List available strings | GET | /config/{app_id}/flows/{flow}/strings |
| Create a string | POST | /config/{app_id}/flows/{flow}/strings |
| Delete a string | DELETE | /config/{app_id}/flows/{flow}/strings/{string} |
| View a string definition | GET | /config/{app_id}/flows/{flow}/strings/{string} |
| Modify a string | PUT | /config/{app_id}/flows/{flow}/strings/{string} |
| Get available translations | GET | /config/{app_id}/flows/{flow}/translations |
| Update a Translation | PATCH | /config/{app_id}/flows/{flow}/translations |
| Create a translation | POST | /config/{app_id}/flows/{flow}/translations |
| Delete a translation key | DELETE | /config/{app_id}/flows/{flow}/translations/{key} |
| Get translations for a translation key | GET | /config/{app_id}/flows/{flow}/translations/{key} |
| View available Hosted Login upgrades | GET | /config/{app_id}/flows/{flow}/upgrades |
| View Login upgrade requirements | GET | /config/{app_id}/flows/{flow}/upgrades/{upgradeId} |
| Upgrade Hosted Login | POST | /config/{app_id}/flows/{flow}/upgrades/{upgradeId} |
| List all versions of a flow | GET | /config/{app_id}/flows/{flow}/versions |
| View a flow version | GET | /config/{app_id}/flows/{flow}/versions/{version} |
| Restore a flow | POST | /config/{app_id}/flows/{flow}/versions/{version} |
| Clients | ||
| Get permissions for all clients | GET | /config/{app_id}/clients |
| Create a client | POST | /config/{app_id}/clients |
| Delete a client | DELETE | /config/{app_id}/clients/{client_id} |
| View an API client | GET | /config/{app_id}/clients/{client_id} |
| Modify an API client | PUT | /config/{app_id}/clients/{client_id} |
| Reset a client secret | PUT | /config/{app_id}/clients/{client_id}/secret |
| View API client settings | GET | /config/{app_id}/clients/{client_id}/settings |
| Modify API client settings | PUT | /config/{app_id}/clients/{client_id}/settings |