{ "uuid": "4ee70901-5b93-413b-9100-4f1e2275a581", "lastMigration": 29, "name": "My Business Account Management API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "2ed688bc-af71-48a2-b6df-87e6629a76e2", "documentation": "Lists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights.", "method": "get", "endpoint": "v1/accounts", "responses": [ { "uuid": "cb072d28-5f26-489d-a86d-cb32e2492578", "body": "{\n \"accounts\": [\n {\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"name\": \"\",\n \"organizationInfo\": {\n \"address\": {\n \"addressLines\": [\n \"\"\n ],\n \"administrativeArea\": \"\",\n \"languageCode\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postalCode\": \"\",\n \"recipients\": [\n \"\"\n ],\n \"regionCode\": \"\",\n \"revision\": {{faker 'number.int' max=99999}},\n \"sortingCode\": \"\",\n \"sublocality\": \"\"\n },\n \"phoneNumber\": \"\",\n \"registeredDomain\": \"\"\n },\n \"permissionLevel\": \"{{oneOf (array 'PERMISSION_LEVEL_UNSPECIFIED' 'OWNER_LEVEL' 'MEMBER_LEVEL')}}\",\n \"primaryOwner\": \"\",\n \"role\": \"{{oneOf (array 'ACCOUNT_ROLE_UNSPECIFIED' 'PRIMARY_OWNER' 'OWNER' 'MANAGER' 'SITE_MANAGER')}}\",\n \"type\": \"{{oneOf (array 'ACCOUNT_TYPE_UNSPECIFIED' 'PERSONAL' 'LOCATION_GROUP' 'USER_GROUP' 'ORGANIZATION')}}\",\n \"verificationState\": \"{{oneOf (array 'VERIFICATION_STATE_UNSPECIFIED' 'VERIFIED' 'UNVERIFIED' 'VERIFICATION_REQUESTED')}}\",\n \"vettedState\": \"{{oneOf (array 'VETTED_STATE_UNSPECIFIED' 'NOT_VETTED' 'VETTED' 'INVALID')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2af1966d-dc0c-4aba-aaf9-107e9c9a70ad", "documentation": "Creates an account with the specified name and type under the given parent. - Personal accounts and Organizations cannot be created. - User Groups cannot be created with a Personal account as primary owner. - Location Groups cannot be created with a primary owner of a Personal account if the Personal account is in an Organization. - Location Groups cannot own Location Groups.", "method": "post", "endpoint": "v1/accounts", "responses": [ { "uuid": "56a5092d-8ff3-48fa-861f-7a873af34551", "body": "{\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"name\": \"\",\n \"organizationInfo\": {\n \"address\": {\n \"addressLines\": [\n \"\"\n ],\n \"administrativeArea\": \"\",\n \"languageCode\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postalCode\": \"\",\n \"recipients\": [\n \"\"\n ],\n \"regionCode\": \"\",\n \"revision\": {{faker 'number.int' max=99999}},\n \"sortingCode\": \"\",\n \"sublocality\": \"\"\n },\n \"phoneNumber\": \"\",\n \"registeredDomain\": \"\"\n },\n \"permissionLevel\": \"{{oneOf (array 'PERMISSION_LEVEL_UNSPECIFIED' 'OWNER_LEVEL' 'MEMBER_LEVEL')}}\",\n \"primaryOwner\": \"\",\n \"role\": \"{{oneOf (array 'ACCOUNT_ROLE_UNSPECIFIED' 'PRIMARY_OWNER' 'OWNER' 'MANAGER' 'SITE_MANAGER')}}\",\n \"type\": \"{{oneOf (array 'ACCOUNT_TYPE_UNSPECIFIED' 'PERSONAL' 'LOCATION_GROUP' 'USER_GROUP' 'ORGANIZATION')}}\",\n \"verificationState\": \"{{oneOf (array 'VERIFICATION_STATE_UNSPECIFIED' 'VERIFIED' 'UNVERIFIED' 'VERIFICATION_REQUESTED')}}\",\n \"vettedState\": \"{{oneOf (array 'VETTED_STATE_UNSPECIFIED' 'NOT_VETTED' 'VETTED' 'INVALID')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bd9851da-bf4a-49dc-8792-32e8990837ea", "documentation": "Removes the specified admin as a manager of the specified location.", "method": "delete", "endpoint": "v1/:name", "responses": [ { "uuid": "3ec7ab27-b031-4cd5-9f9a-8c2c90b2ff40", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "042e74d8-54e7-43d2-9617-b0d88af8163b", "documentation": "Gets the specified account. Returns `NOT_FOUND` if the account does not exist or if the caller does not have access rights to it.", "method": "get", "endpoint": "v1/:name", "responses": [ { "uuid": "90cef47f-c784-4775-a7a3-02150bdea905", "body": "{\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"name\": \"\",\n \"organizationInfo\": {\n \"address\": {\n \"addressLines\": [\n \"\"\n ],\n \"administrativeArea\": \"\",\n \"languageCode\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postalCode\": \"\",\n \"recipients\": [\n \"\"\n ],\n \"regionCode\": \"\",\n \"revision\": {{faker 'number.int' max=99999}},\n \"sortingCode\": \"\",\n \"sublocality\": \"\"\n },\n \"phoneNumber\": \"\",\n \"registeredDomain\": \"\"\n },\n \"permissionLevel\": \"{{oneOf (array 'PERMISSION_LEVEL_UNSPECIFIED' 'OWNER_LEVEL' 'MEMBER_LEVEL')}}\",\n \"primaryOwner\": \"\",\n \"role\": \"{{oneOf (array 'ACCOUNT_ROLE_UNSPECIFIED' 'PRIMARY_OWNER' 'OWNER' 'MANAGER' 'SITE_MANAGER')}}\",\n \"type\": \"{{oneOf (array 'ACCOUNT_TYPE_UNSPECIFIED' 'PERSONAL' 'LOCATION_GROUP' 'USER_GROUP' 'ORGANIZATION')}}\",\n \"verificationState\": \"{{oneOf (array 'VERIFICATION_STATE_UNSPECIFIED' 'VERIFIED' 'UNVERIFIED' 'VERIFICATION_REQUESTED')}}\",\n \"vettedState\": \"{{oneOf (array 'VETTED_STATE_UNSPECIFIED' 'NOT_VETTED' 'VETTED' 'INVALID')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e5ca75dc-e0ad-40f7-8a88-031270842e60", "documentation": "Updates the Admin for the specified location. Only the AdminRole of the Admin can be updated.", "method": "patch", "endpoint": "v1/:name", "responses": [ { "uuid": "f6c8fb93-460a-44e8-aac7-a6c924f1ed81", "body": "{\n \"account\": \"\",\n \"admin\": \"\",\n \"name\": \"\",\n \"pendingInvitation\": {{faker 'datatype.boolean'}},\n \"role\": \"{{oneOf (array 'ADMIN_ROLE_UNSPECIFIED' 'PRIMARY_OWNER' 'OWNER' 'MANAGER' 'SITE_MANAGER')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d3c4018a-6a15-4595-ae73-c023beadd477", "documentation": "Accepts the specified invitation.", "method": "post", "endpoint": "v1/:name:accept", "responses": [ { "uuid": "c427679a-1a4a-4a32-9f8a-24f1aa3cc1dc", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ecf56efc-da15-4130-81bb-047522fa2c75", "documentation": "Declines the specified invitation.", "method": "post", "endpoint": "v1/:name:decline", "responses": [ { "uuid": "4fc3637c-1da1-4f3f-b175-753536ece75f", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3d31df61-5408-479f-9218-7cee69c81c8b", "documentation": "Moves a location from an account that the user owns to another account that the same user administers. The user must be an owner of the account the location is currently associated with and must also be at least a manager of the destination account.", "method": "post", "endpoint": "v1/:name:transfer", "responses": [ { "uuid": "df78e3a2-138d-4dfa-a4c0-f69c30fe60e0", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3da49047-71b9-48a8-8e72-bfc3a83dd6a5", "documentation": "Lists all of the admins for the specified location.", "method": "get", "endpoint": "v1/:parent/admins", "responses": [ { "uuid": "26539ce6-8f25-422e-b3d7-29f5e0ccc9b1", "body": "{\n \"admins\": [\n {\n \"account\": \"\",\n \"admin\": \"\",\n \"name\": \"\",\n \"pendingInvitation\": {{faker 'datatype.boolean'}},\n \"role\": \"{{oneOf (array 'ADMIN_ROLE_UNSPECIFIED' 'PRIMARY_OWNER' 'OWNER' 'MANAGER' 'SITE_MANAGER')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d8fbdc4-652c-40f4-8800-8d269c8d387a", "documentation": "Invites the specified user to become an administrator for the specified location. The invitee must accept the invitation in order to be granted access to the location. See AcceptInvitation to programmatically accept an invitation.", "method": "post", "endpoint": "v1/:parent/admins", "responses": [ { "uuid": "efb61d97-23fb-4d1c-aa80-12f48acae158", "body": "{\n \"account\": \"\",\n \"admin\": \"\",\n \"name\": \"\",\n \"pendingInvitation\": {{faker 'datatype.boolean'}},\n \"role\": \"{{oneOf (array 'ADMIN_ROLE_UNSPECIFIED' 'PRIMARY_OWNER' 'OWNER' 'MANAGER' 'SITE_MANAGER')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bd5d768f-6839-46b2-8124-f1d8a0080a34", "documentation": "Lists pending invitations for the specified account.", "method": "get", "endpoint": "v1/:parent/invitations", "responses": [ { "uuid": "a6d8e445-f3ed-49ae-b3ec-fc3c2428d1fb", "body": "{\n \"invitations\": [\n {\n \"name\": \"\",\n \"role\": \"{{oneOf (array 'ADMIN_ROLE_UNSPECIFIED' 'PRIMARY_OWNER' 'OWNER' 'MANAGER' 'SITE_MANAGER')}}\",\n \"targetAccount\": {\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"name\": \"\",\n \"organizationInfo\": {\n \"address\": {\n \"addressLines\": [\n \"\"\n ],\n \"administrativeArea\": \"\",\n \"languageCode\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postalCode\": \"\",\n \"recipients\": [\n \"\"\n ],\n \"regionCode\": \"\",\n \"revision\": {{faker 'number.int' max=99999}},\n \"sortingCode\": \"\",\n \"sublocality\": \"\"\n },\n \"phoneNumber\": \"\",\n \"registeredDomain\": \"\"\n },\n \"permissionLevel\": \"{{oneOf (array 'PERMISSION_LEVEL_UNSPECIFIED' 'OWNER_LEVEL' 'MEMBER_LEVEL')}}\",\n \"primaryOwner\": \"\",\n \"role\": \"{{oneOf (array 'ACCOUNT_ROLE_UNSPECIFIED' 'PRIMARY_OWNER' 'OWNER' 'MANAGER' 'SITE_MANAGER')}}\",\n \"type\": \"{{oneOf (array 'ACCOUNT_TYPE_UNSPECIFIED' 'PERSONAL' 'LOCATION_GROUP' 'USER_GROUP' 'ORGANIZATION')}}\",\n \"verificationState\": \"{{oneOf (array 'VERIFICATION_STATE_UNSPECIFIED' 'VERIFIED' 'UNVERIFIED' 'VERIFICATION_REQUESTED')}}\",\n \"vettedState\": \"{{oneOf (array 'VETTED_STATE_UNSPECIFIED' 'NOT_VETTED' 'VETTED' 'INVALID')}}\"\n },\n \"targetLocation\": {\n \"address\": \"\",\n \"locationName\": \"\"\n },\n \"targetType\": \"{{oneOf (array 'TARGET_TYPE_UNSPECIFIED' 'ACCOUNTS_ONLY' 'LOCATIONS_ONLY')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "2ed688bc-af71-48a2-b6df-87e6629a76e2" }, { "type": "route", "uuid": "2af1966d-dc0c-4aba-aaf9-107e9c9a70ad" }, { "type": "route", "uuid": "bd9851da-bf4a-49dc-8792-32e8990837ea" }, { "type": "route", "uuid": "042e74d8-54e7-43d2-9617-b0d88af8163b" }, { "type": "route", "uuid": "e5ca75dc-e0ad-40f7-8a88-031270842e60" }, { "type": "route", "uuid": "d3c4018a-6a15-4595-ae73-c023beadd477" }, { "type": "route", "uuid": "ecf56efc-da15-4130-81bb-047522fa2c75" }, { "type": "route", "uuid": "3d31df61-5408-479f-9218-7cee69c81c8b" }, { "type": "route", "uuid": "3da49047-71b9-48a8-8e72-bfc3a83dd6a5" }, { "type": "route", "uuid": "7d8fbdc4-652c-40f4-8800-8d269c8d387a" }, { "type": "route", "uuid": "bd5d768f-6839-46b2-8124-f1d8a0080a34" } ] }